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

package/src/state/state.ts

@@ -8,21 +8,75 @@ 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 {
+  useQuery,
+  UseQueryOptions,
+  QueryFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
+import type {
+  StateGetVersionResponse,
+  AsError,
+} from "../account-server-api.schemas";
+import { customInstance, ErrorType } from ".././custom-instance";
+
+// 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;
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type SecondParameter<T extends (...args: any) => any> = T extends (
+  config: any,
+  args: infer P
+) => any
+  ? P
+  : never;
+
+/**
+ * @summary Gets the Account Server version
+ */
+export const getVersion = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<StateGetVersionResponse>(
+    { url: `/version`, method: "get" },
+    options
+  );
+};
+
+export const getGetVersionQueryKey = () => [`/version`];
+
+export type GetVersionQueryResult = NonNullable<
+  AsyncReturnType<typeof getVersion>
+>;
+export type GetVersionQueryError = ErrorType<AsError | void>;
+
+export const useGetVersion = <
+  TData = AsyncReturnType<typeof getVersion>,
+  TError = ErrorType<AsError | void>
+>(options?: {
+  query?: UseQueryOptions<AsyncReturnType<typeof getVersion>, TError, TData>;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetVersionQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getVersion>> = () =>
+    getVersion(requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getVersion>, TError, TData>(
+    queryKey,
+    queryFn,
+    queryOptions
+  );
+
+  return {
+    queryKey,
+    ...query,
   };
-  return { appApiStateGetVersion };
 };
-export type AppApiStateGetVersionResult =
-  AxiosResponse<StateGetVersionResponse>;

package/src/unit/unit.ts

@@ -8,118 +8,398 @@ 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 {
+  useQuery,
+  useMutation,
+  UseQueryOptions,
+  UseMutationOptions,
+  QueryFunction,
+  MutationFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
 import type {
   OrganisationUnitsGetResponse,
+  AsError,
   OrganisationUnitPostResponse,
   OrganisationUnitPostBodyBody,
   UnitGetResponse,
   UnitsGetResponse,
   PersonalUnitPutResponse,
 } from "../account-server-api.schemas";
+import { customInstance, ErrorType } from ".././custom-instance";
 
-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;
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type SecondParameter<T extends (...args: any) => any> = T extends (
+  config: any,
+  args: infer P
+) => any
+  ? P
+  : never;
+
+/**
+ * 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 getOrganisationUnits = (
+  orgId: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<OrganisationUnitsGetResponse>(
+    { url: `/organisation/${orgId}/unit`, method: "get" },
+    options
+  );
+};
+
+export const getGetOrganisationUnitsQueryKey = (orgId: string) => [
+  `/organisation/${orgId}/unit`,
+];
+
+export type GetOrganisationUnitsQueryResult = NonNullable<
+  AsyncReturnType<typeof getOrganisationUnits>
+>;
+export type GetOrganisationUnitsQueryError = ErrorType<void | AsError>;
+
+export const useGetOrganisationUnits = <
+  TData = AsyncReturnType<typeof getOrganisationUnits>,
+  TError = ErrorType<void | AsError>
+>(
+  orgId: string,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof getOrganisationUnits>,
+      TError,
+      TData
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getGetOrganisationUnitsQueryKey(orgId);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof getOrganisationUnits>
+  > = () => getOrganisationUnits(orgId, requestOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof getOrganisationUnits>,
+    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 createOrganisationUnit = (
+  orgId: string,
+  organisationUnitPostBodyBody: OrganisationUnitPostBodyBody,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<OrganisationUnitPostResponse>(
+    {
+      url: `/organisation/${orgId}/unit`,
+      method: "post",
+      headers: { "Content-Type": "application/json" },
+      data: organisationUnitPostBodyBody,
+    },
+    options
+  );
+};
+
+export type CreateOrganisationUnitMutationResult = NonNullable<
+  AsyncReturnType<typeof createOrganisationUnit>
+>;
+export type CreateOrganisationUnitMutationBody = OrganisationUnitPostBodyBody;
+export type CreateOrganisationUnitMutationError = ErrorType<AsError | void>;
+
+export const useCreateOrganisationUnit = <
+  TError = ErrorType<AsError | void>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof createOrganisationUnit>,
+    TError,
+    { orgId: string; data: OrganisationUnitPostBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof createOrganisationUnit>,
+    { orgId: string; data: OrganisationUnitPostBodyBody }
+  > = (props) => {
+    const { orgId, data } = props || {};
+
+    return createOrganisationUnit(orgId, data, requestOptions);
   };
-  /**
- * Gets the Unit, assuming you are a member of it. Admin users can see all Units
+
+  return useMutation<
+    AsyncReturnType<typeof createOrganisationUnit>,
+    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 getUnit = (
+  orgId: string,
+  unitId: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<UnitGetResponse>(
+    { url: `/organisation/${orgId}/unit/${unitId}`, method: "get" },
+    options
+  );
+};
+
+export const getGetUnitQueryKey = (orgId: string, unitId: string) => [
+  `/organisation/${orgId}/unit/${unitId}`,
+];
+
+export type GetUnitQueryResult = NonNullable<AsyncReturnType<typeof getUnit>>;
+export type GetUnitQueryError = ErrorType<void | AsError>;
+
+export const useGetUnit = <
+  TData = AsyncReturnType<typeof getUnit>,
+  TError = ErrorType<void | AsError>
+>(
+  orgId: string,
+  unitId: string,
+  options?: {
+    query?: UseQueryOptions<AsyncReturnType<typeof getUnit>, TError, TData>;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetUnitQueryKey(orgId, unitId);
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getUnit>> = () =>
+    getUnit(orgId, unitId, requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getUnit>, 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 deleteOrganisationUnit = (
+  orgId: string,
+  unitId: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    { url: `/organisation/${orgId}/unit/${unitId}`, method: "delete" },
+    options
+  );
+};
+
+export type DeleteOrganisationUnitMutationResult = NonNullable<
+  AsyncReturnType<typeof deleteOrganisationUnit>
+>;
+
+export type DeleteOrganisationUnitMutationError = ErrorType<AsError>;
+
+export const useDeleteOrganisationUnit = <
+  TError = ErrorType<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof deleteOrganisationUnit>,
+    TError,
+    { orgId: string; unitId: string },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof deleteOrganisationUnit>,
+    { orgId: string; unitId: string }
+  > = (props) => {
+    const { orgId, unitId } = props || {};
+
+    return deleteOrganisationUnit(orgId, unitId, requestOptions);
   };
-  /**
- * 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 deleteOrganisationUnit>,
+    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 getUnits = (options?: SecondParameter<typeof customInstance>) => {
+  return customInstance<UnitsGetResponse>(
+    { url: `/unit`, method: "get" },
+    options
+  );
+};
+
+export const getGetUnitsQueryKey = () => [`/unit`];
+
+export type GetUnitsQueryResult = NonNullable<AsyncReturnType<typeof getUnits>>;
+export type GetUnitsQueryError = ErrorType<void | AsError>;
+
+export const useGetUnits = <
+  TData = AsyncReturnType<typeof getUnits>,
+  TError = ErrorType<void | AsError>
+>(options?: {
+  query?: UseQueryOptions<AsyncReturnType<typeof getUnits>, TError, TData>;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetUnitsQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getUnits>> = () =>
+    getUnits(requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getUnits>, 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 createDefaultUnit = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<PersonalUnitPutResponse>(
+    { url: `/unit`, method: "put" },
+    options
+  );
+};
+
+export type CreateDefaultUnitMutationResult = NonNullable<
+  AsyncReturnType<typeof createDefaultUnit>
+>;
+
+export type CreateDefaultUnitMutationError = ErrorType<AsError | void>;
+
+export const useCreateDefaultUnit = <
+  TError = ErrorType<AsError | void>,
+  TVariables = void,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof createDefaultUnit>,
+    TError,
+    TVariables,
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof createDefaultUnit>,
+    TVariables
+  > = () => {
+    return createDefaultUnit(requestOptions);
   };
-  /**
+
+  return useMutation<
+    AsyncReturnType<typeof createDefaultUnit>,
+    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 deleteDefaultUnit = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>({ url: `/unit`, method: "delete" }, options);
+};
+
+export type DeleteDefaultUnitMutationResult = NonNullable<
+  AsyncReturnType<typeof deleteDefaultUnit>
+>;
+
+export type DeleteDefaultUnitMutationError = ErrorType<AsError>;
+
+export const useDeleteDefaultUnit = <
+  TError = ErrorType<AsError>,
+  TVariables = void,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof deleteDefaultUnit>,
+    TError,
+    TVariables,
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof deleteDefaultUnit>,
+    TVariables
+  > = () => {
+    return deleteDefaultUnit(requestOptions);
   };
+
+  return useMutation<
+    AsyncReturnType<typeof deleteDefaultUnit>,
+    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>;