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

package/src/organisation/organisation.ts

@@ -8,78 +8,253 @@ 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 {
   OrganisationsGetResponse,
+  AsError,
   OrganisationPostResponse,
   OrganisationPostBodyBody,
   OrganisationGetDefaultResponse,
 } from "../account-server-api.schemas";
+import { customInstance, ErrorType } from ".././custom-instance";
 
-export const getOrganisation = () => {
-  /**
- * Gets all the Organisations you are a member of. Admin users can see all Organisations
+// 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 all the Organisations that you are a member of or are public. Admin users are members of all organisation and can see all Organisations
 
  * @summary Gets Organisations
  */
-  const appApiOrganisationGet = <
-    TData = AxiosResponse<OrganisationsGetResponse>
-  >(
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/organisation`, options);
+export const getOrganisations = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<OrganisationsGetResponse>(
+    { url: `/organisation`, method: "get" },
+    options
+  );
+};
+
+export const getGetOrganisationsQueryKey = () => [`/organisation`];
+
+export type GetOrganisationsQueryResult = NonNullable<
+  AsyncReturnType<typeof getOrganisations>
+>;
+export type GetOrganisationsQueryError = ErrorType<void | AsError>;
+
+export const useGetOrganisations = <
+  TData = AsyncReturnType<typeof getOrganisations>,
+  TError = ErrorType<void | AsError>
+>(options?: {
+  query?: UseQueryOptions<
+    AsyncReturnType<typeof getOrganisations>,
+    TError,
+    TData
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetOrganisationsQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getOrganisations>> = () =>
+    getOrganisations(requestOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof getOrganisations>,
+    TError,
+    TData
+  >(queryKey, queryFn, queryOptions);
+
+  return {
+    queryKey,
+    ...query,
   };
-  /**
+};
+
+/**
  * Creates a new Organisation
 
 You need **admin** rights to use this method
 
  * @summary Create a new organisation
  */
-  const appApiOrganisationPost = <
-    TData = AxiosResponse<OrganisationPostResponse>
-  >(
-    organisationPostBodyBody: OrganisationPostBodyBody,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.post(`/organisation`, organisationPostBodyBody, options);
+export const createOrganisation = (
+  organisationPostBodyBody: OrganisationPostBodyBody,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<OrganisationPostResponse>(
+    {
+      url: `/organisation`,
+      method: "post",
+      headers: { "Content-Type": "application/json" },
+      data: organisationPostBodyBody,
+    },
+    options
+  );
+};
+
+export type CreateOrganisationMutationResult = NonNullable<
+  AsyncReturnType<typeof createOrganisation>
+>;
+export type CreateOrganisationMutationBody = OrganisationPostBodyBody;
+export type CreateOrganisationMutationError = ErrorType<AsError | void>;
+
+export const useCreateOrganisation = <
+  TError = ErrorType<AsError | void>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof createOrganisation>,
+    TError,
+    { data: OrganisationPostBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof createOrganisation>,
+    { data: OrganisationPostBodyBody }
+  > = (props) => {
+    const { data } = props || {};
+
+    return createOrganisation(data, requestOptions);
   };
-  /**
+
+  return useMutation<
+    AsyncReturnType<typeof createOrganisation>,
+    TError,
+    { data: OrganisationPostBodyBody },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
  * Units must first be deleted before an Organisation can be deleted
 
 You need **admin** rights to use this method
 
  * @summary Deletes an Organisation
  */
-  const appApiOrganisationDelete = <TData = AxiosResponse<void>>(
-    orgId: string,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.delete(`/organisation/${orgId}`, options);
+export const deleteOrganisation = (
+  orgId: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    { url: `/organisation/${orgId}`, method: "delete" },
+    options
+  );
+};
+
+export type DeleteOrganisationMutationResult = NonNullable<
+  AsyncReturnType<typeof deleteOrganisation>
+>;
+
+export type DeleteOrganisationMutationError = ErrorType<AsError>;
+
+export const useDeleteOrganisation = <
+  TError = ErrorType<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof deleteOrganisation>,
+    TError,
+    { orgId: string },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof deleteOrganisation>,
+    { orgId: string }
+  > = (props) => {
+    const { orgId } = props || {};
+
+    return deleteOrganisation(orgId, requestOptions);
   };
-  /**
- * Gets the built-in Default Organisation, used exclusively for Independent Units
+
+  return useMutation<
+    AsyncReturnType<typeof deleteOrganisation>,
+    TError,
+    { orgId: string },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
+ * Gets the built-in Default Organisation, used exclusively for Personal Units
 
  * @summary Gets the (built-in) Default Organisation
  */
-  const appApiOrganisationGetDefault = <
-    TData = AxiosResponse<OrganisationGetDefaultResponse>
-  >(
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/organisation/default`, options);
-  };
+export const getDefaultOrganisation = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<OrganisationGetDefaultResponse>(
+    { url: `/organisation/default`, method: "get" },
+    options
+  );
+};
+
+export const getGetDefaultOrganisationQueryKey = () => [
+  `/organisation/default`,
+];
+
+export type GetDefaultOrganisationQueryResult = NonNullable<
+  AsyncReturnType<typeof getDefaultOrganisation>
+>;
+export type GetDefaultOrganisationQueryError = ErrorType<void | AsError>;
+
+export const useGetDefaultOrganisation = <
+  TData = AsyncReturnType<typeof getDefaultOrganisation>,
+  TError = ErrorType<void | AsError>
+>(options?: {
+  query?: UseQueryOptions<
+    AsyncReturnType<typeof getDefaultOrganisation>,
+    TError,
+    TData
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getGetDefaultOrganisationQueryKey();
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof getDefaultOrganisation>
+  > = () => getDefaultOrganisation(requestOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof getDefaultOrganisation>,
+    TError,
+    TData
+  >(queryKey, queryFn, queryOptions);
+
   return {
-    appApiOrganisationGet,
-    appApiOrganisationPost,
-    appApiOrganisationDelete,
-    appApiOrganisationGetDefault,
+    queryKey,
+    ...query,
   };
 };
-export type AppApiOrganisationGetResult =
-  AxiosResponse<OrganisationsGetResponse>;
-export type AppApiOrganisationPostResult =
-  AxiosResponse<OrganisationPostResponse>;
-export type AppApiOrganisationDeleteResult = AxiosResponse<void>;
-export type AppApiOrganisationGetDefaultResult =
-  AxiosResponse<OrganisationGetDefaultResponse>;