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

package/src/state/state.ts

@@ -8,21 +8,69 @@ 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 type { StateGetVersionResponse } from "../account-server-api.schemas";
-
-export const getState = () => {
-  /**
-   * @summary Gets the Account Server version
-   */
-  const appApiStateGetVersion = <
-    TData = AxiosResponse<StateGetVersionResponse>
-  >(
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/version`, options);
+import axios, { AxiosRequestConfig, AxiosResponse, AxiosError } from "axios";
+import {
+  useQuery,
+  UseQueryOptions,
+  QueryFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
+import type {
+  StateGetVersionResponse,
+  AsError,
+} from "../account-server-api.schemas";
+
+// 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;
+
+/**
+ * @summary Gets the Account Server version
+ */
+export const appApiStateGetVersion = (
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<StateGetVersionResponse>> => {
+  return axios.get(`/version`, options);
+};
+
+export const getAppApiStateGetVersionQueryKey = () => [`/version`];
+
+export type AppApiStateGetVersionQueryResult = NonNullable<
+  AsyncReturnType<typeof appApiStateGetVersion>
+>;
+export type AppApiStateGetVersionQueryError = AxiosError<AsError | void>;
+
+export const useAppApiStateGetVersion = <
+  TData = AsyncReturnType<typeof appApiStateGetVersion>,
+  TError = AxiosError<AsError | void>
+>(options?: {
+  query?: UseQueryOptions<
+    AsyncReturnType<typeof appApiStateGetVersion>,
+    TError,
+    TData
+  >;
+  axios?: AxiosRequestConfig;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, axios: axiosOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getAppApiStateGetVersionQueryKey();
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof appApiStateGetVersion>
+  > = () => appApiStateGetVersion(axiosOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof appApiStateGetVersion>,
+    TError,
+    TData
+  >(queryKey, queryFn, queryOptions);
+
+  return {
+    queryKey,
+    ...query,
   };
-  return { appApiStateGetVersion };
 };
-export type AppApiStateGetVersionResult =
-  AxiosResponse<StateGetVersionResponse>;

package/src/unit/unit.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 {
   OrganisationUnitsGetResponse,
+  AsError,
   OrganisationUnitPostResponse,
   OrganisationUnitPostBodyBody,
   UnitGetResponse,
@@ -18,108 +29,362 @@ import type {
   PersonalUnitPutResponse,
 } from "../account-server-api.schemas";
 
-export const getUnit = () => {
-  /**
- * Gets Organisational Units you have access to
+// 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 Organisational Units you have access to or that are public
 
  * @summary Gets Organisational Units
  */
-  const appApiUnitGetOrgUnits = <
-    TData = AxiosResponse<OrganisationUnitsGetResponse>
-  >(
-    orgId: string,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/organisation/${orgId}/unit`, options);
+export const appApiUnitGetOrgUnits = (
+  orgId: string,
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<OrganisationUnitsGetResponse>> => {
+  return axios.get(`/organisation/${orgId}/unit`, options);
+};
+
+export const getAppApiUnitGetOrgUnitsQueryKey = (orgId: string) => [
+  `/organisation/${orgId}/unit`,
+];
+
+export type AppApiUnitGetOrgUnitsQueryResult = NonNullable<
+  AsyncReturnType<typeof appApiUnitGetOrgUnits>
+>;
+export type AppApiUnitGetOrgUnitsQueryError = AxiosError<void | AsError>;
+
+export const useAppApiUnitGetOrgUnits = <
+  TData = AsyncReturnType<typeof appApiUnitGetOrgUnits>,
+  TError = AxiosError<void | AsError>
+>(
+  orgId: string,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof appApiUnitGetOrgUnits>,
+      TError,
+      TData
+    >;
+    axios?: AxiosRequestConfig;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, axios: axiosOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getAppApiUnitGetOrgUnitsQueryKey(orgId);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof appApiUnitGetOrgUnits>
+  > = () => appApiUnitGetOrgUnits(orgId, axiosOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof appApiUnitGetOrgUnits>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!orgId, ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
   };
-  /**
+};
+
+/**
  * Creates a new organisation unit. You need to be in the Organisation or an Admin user to use this endpoint
 
  * @summary Create a new Organisational Unit
  */
-  const appApiUnitPost = <TData = AxiosResponse<OrganisationUnitPostResponse>>(
-    orgId: string,
-    organisationUnitPostBodyBody: OrganisationUnitPostBodyBody,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.post(
-      `/organisation/${orgId}/unit`,
-      organisationUnitPostBodyBody,
-      options
-    );
+export const appApiUnitPost = (
+  orgId: string,
+  organisationUnitPostBodyBody: OrganisationUnitPostBodyBody,
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<OrganisationUnitPostResponse>> => {
+  return axios.post(
+    `/organisation/${orgId}/unit`,
+    organisationUnitPostBodyBody,
+    options
+  );
+};
+
+export type AppApiUnitPostMutationResult = NonNullable<
+  AsyncReturnType<typeof appApiUnitPost>
+>;
+export type AppApiUnitPostMutationBody = OrganisationUnitPostBodyBody;
+export type AppApiUnitPostMutationError = AxiosError<AsError | void>;
+
+export const useAppApiUnitPost = <
+  TError = AxiosError<AsError | void>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof appApiUnitPost>,
+    TError,
+    { orgId: string; data: OrganisationUnitPostBodyBody },
+    TContext
+  >;
+  axios?: AxiosRequestConfig;
+}) => {
+  const { mutation: mutationOptions, axios: axiosOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof appApiUnitPost>,
+    { orgId: string; data: OrganisationUnitPostBodyBody }
+  > = (props) => {
+    const { orgId, data } = props || {};
+
+    return appApiUnitPost(orgId, data, axiosOptions);
   };
-  /**
- * Gets the Unit, assuming you are a member of it. Admin users can see all Units
+
+  return useMutation<
+    AsyncReturnType<typeof appApiUnitPost>,
+    TError,
+    { orgId: string; data: OrganisationUnitPostBodyBody },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
+ * Gets the Unit, assuming you are a member of it or it is public. Admin users can see all Units
 
  * @summary Gets a Unit
  */
-  const appApiUnitGetUnit = <TData = AxiosResponse<UnitGetResponse>>(
-    orgId: string,
-    unitId: string,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/organisation/${orgId}/unit/${unitId}`, options);
+export const appApiUnitGetUnit = (
+  orgId: string,
+  unitId: string,
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<UnitGetResponse>> => {
+  return axios.get(`/organisation/${orgId}/unit/${unitId}`, options);
+};
+
+export const getAppApiUnitGetUnitQueryKey = (orgId: string, unitId: string) => [
+  `/organisation/${orgId}/unit/${unitId}`,
+];
+
+export type AppApiUnitGetUnitQueryResult = NonNullable<
+  AsyncReturnType<typeof appApiUnitGetUnit>
+>;
+export type AppApiUnitGetUnitQueryError = AxiosError<void | AsError>;
+
+export const useAppApiUnitGetUnit = <
+  TData = AsyncReturnType<typeof appApiUnitGetUnit>,
+  TError = AxiosError<void | AsError>
+>(
+  orgId: string,
+  unitId: string,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof appApiUnitGetUnit>,
+      TError,
+      TData
+    >;
+    axios?: AxiosRequestConfig;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, axios: axiosOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getAppApiUnitGetUnitQueryKey(orgId, unitId);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof appApiUnitGetUnit>
+  > = () => appApiUnitGetUnit(orgId, unitId, axiosOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof appApiUnitGetUnit>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!(orgId && unitId), ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
   };
-  /**
+};
+
+/**
  * Deletes an Organisational Unit you have access to. Units can only be deleted by Organisation users or Admin users. You cannot delete a Unit that contains Products
 
  * @summary Deletes an Organisational Unit
  */
-  const appApiUnitDelete = <TData = AxiosResponse<void>>(
-    orgId: string,
-    unitId: string,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.delete(`/organisation/${orgId}/unit/${unitId}`, options);
+export const appApiUnitDelete = (
+  orgId: string,
+  unitId: string,
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<void>> => {
+  return axios.delete(`/organisation/${orgId}/unit/${unitId}`, options);
+};
+
+export type AppApiUnitDeleteMutationResult = NonNullable<
+  AsyncReturnType<typeof appApiUnitDelete>
+>;
+
+export type AppApiUnitDeleteMutationError = AxiosError<AsError>;
+
+export const useAppApiUnitDelete = <
+  TError = AxiosError<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof appApiUnitDelete>,
+    TError,
+    { orgId: string; unitId: string },
+    TContext
+  >;
+  axios?: AxiosRequestConfig;
+}) => {
+  const { mutation: mutationOptions, axios: axiosOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof appApiUnitDelete>,
+    { orgId: string; unitId: string }
+  > = (props) => {
+    const { orgId, unitId } = props || {};
+
+    return appApiUnitDelete(orgId, unitId, axiosOptions);
   };
-  /**
- * Gets all the Units you are a member of. Admin users can see all Units
 
- * @summary Gets Units a User has access to
+  return useMutation<
+    AsyncReturnType<typeof appApiUnitDelete>,
+    TError,
+    { orgId: string; unitId: string },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
+ * Gets all the Units that are public or you are a member of. Admin users can see all Units
+
+ * @summary Gets Units
  */
-  const appApiUnitGet = <TData = AxiosResponse<UnitsGetResponse>>(
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/unit`, options);
+export const appApiUnitGet = (
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<UnitsGetResponse>> => {
+  return axios.get(`/unit`, options);
+};
+
+export const getAppApiUnitGetQueryKey = () => [`/unit`];
+
+export type AppApiUnitGetQueryResult = NonNullable<
+  AsyncReturnType<typeof appApiUnitGet>
+>;
+export type AppApiUnitGetQueryError = AxiosError<void | AsError>;
+
+export const useAppApiUnitGet = <
+  TData = AsyncReturnType<typeof appApiUnitGet>,
+  TError = AxiosError<void | AsError>
+>(options?: {
+  query?: UseQueryOptions<AsyncReturnType<typeof appApiUnitGet>, TError, TData>;
+  axios?: AxiosRequestConfig;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, axios: axiosOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getAppApiUnitGetQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof appApiUnitGet>> = () =>
+    appApiUnitGet(axiosOptions);
+
+  const query = useQuery<AsyncReturnType<typeof appApiUnitGet>, TError, TData>(
+    queryKey,
+    queryFn,
+    queryOptions
+  );
+
+  return {
+    queryKey,
+    ...query,
   };
-  /**
+};
+
+/**
  * Creates a 'Personal' Unit for a User. The unit will belong to the built-in **Default** Organisation. Users can only have one Personal Unit and Personal Units cannot have other Users
 
  * @summary Create a new Independent User Unit
  */
-  const appApiUnitPersonalPut = <
-    TData = AxiosResponse<PersonalUnitPutResponse>
-  >(
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.put(`/unit`, undefined, options);
+export const appApiUnitPersonalPut = (
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<PersonalUnitPutResponse>> => {
+  return axios.put(`/unit`, undefined, options);
+};
+
+export type AppApiUnitPersonalPutMutationResult = NonNullable<
+  AsyncReturnType<typeof appApiUnitPersonalPut>
+>;
+
+export type AppApiUnitPersonalPutMutationError = AxiosError<AsError | void>;
+
+export const useAppApiUnitPersonalPut = <
+  TError = AxiosError<AsError | void>,
+  TVariables = void,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof appApiUnitPersonalPut>,
+    TError,
+    TVariables,
+    TContext
+  >;
+  axios?: AxiosRequestConfig;
+}) => {
+  const { mutation: mutationOptions, axios: axiosOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof appApiUnitPersonalPut>,
+    TVariables
+  > = () => {
+    return appApiUnitPersonalPut(axiosOptions);
   };
-  /**
+
+  return useMutation<
+    AsyncReturnType<typeof appApiUnitPersonalPut>,
+    TError,
+    TVariables,
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
  * Deletes a 'Personal' Unit. It must be your Unit, which belongs to the Default Organisation
 
  * @summary Deletes an Independent Unit
  */
-  const appApiUnitPersonalDelete = <TData = AxiosResponse<void>>(
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.delete(`/unit`, options);
-  };
-  return {
-    appApiUnitGetOrgUnits,
-    appApiUnitPost,
-    appApiUnitGetUnit,
-    appApiUnitDelete,
-    appApiUnitGet,
-    appApiUnitPersonalPut,
-    appApiUnitPersonalDelete,
+export const appApiUnitPersonalDelete = (
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<void>> => {
+  return axios.delete(`/unit`, options);
+};
+
+export type AppApiUnitPersonalDeleteMutationResult = NonNullable<
+  AsyncReturnType<typeof appApiUnitPersonalDelete>
+>;
+
+export type AppApiUnitPersonalDeleteMutationError = AxiosError<AsError>;
+
+export const useAppApiUnitPersonalDelete = <
+  TError = AxiosError<AsError>,
+  TVariables = void,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof appApiUnitPersonalDelete>,
+    TError,
+    TVariables,
+    TContext
+  >;
+  axios?: AxiosRequestConfig;
+}) => {
+  const { mutation: mutationOptions, axios: axiosOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof appApiUnitPersonalDelete>,
+    TVariables
+  > = () => {
+    return appApiUnitPersonalDelete(axiosOptions);
   };
+
+  return useMutation<
+    AsyncReturnType<typeof appApiUnitPersonalDelete>,
+    TError,
+    TVariables,
+    TContext
+  >(mutationFn, mutationOptions);
 };
-export type AppApiUnitGetOrgUnitsResult =
-  AxiosResponse<OrganisationUnitsGetResponse>;
-export type AppApiUnitPostResult = AxiosResponse<OrganisationUnitPostResponse>;
-export type AppApiUnitGetUnitResult = AxiosResponse<UnitGetResponse>;
-export type AppApiUnitDeleteResult = AxiosResponse<void>;
-export type AppApiUnitGetResult = AxiosResponse<UnitsGetResponse>;
-export type AppApiUnitPersonalPutResult =
-  AxiosResponse<PersonalUnitPutResponse>;
-export type AppApiUnitPersonalDeleteResult = AxiosResponse<void>;