@squonk/account-server-client 0.1.7-rc.1 → 0.1.11-rc.1

package/src/custom-instance.ts

@@ -0,0 +1,52 @@
+/** Based off the example custom-instance from Orval docs
+ * https://github.com/anymaniax/orval/blob/master/samples/react-app-with-react-query/src/api/mutator/custom-instance.ts
+ *
+ * See https://react-query.tanstack.com/guides/query-cancellation
+ *
+ * TODO: Considering using Fetch-API instead of axios. This instance will have to change. Could be
+ * achieved without changing much using `redaxios`
+ * Or use 'ky'
+ */
+
+import Axios, { AxiosError, AxiosRequestConfig } from 'axios';
+
+// ? Need the baseUrl or does it default to ''?
+export const AXIOS_INSTANCE = Axios.create({ baseURL: '' });
+
+/**
+ * Set the access token to be added as the `Authorization: Bearer 'token'` header
+ * Useful for client only apps where a proxy API route isn't involved to securely add the access token
+ * @param token access token
+ */
+export const setAuthToken = (token: string) => {
+  AXIOS_INSTANCE.defaults.headers.common['Authorization'] = `Bearer ${token}`;
+};
+
+/**
+ * Set the url to which request paths are added to.
+ * @param baseUrl origin + subpath e.g. 'https://example.com/subpath' or '/subpath'
+ */
+export const setBaseUrl = (baseUrl: string) => {
+  AXIOS_INSTANCE.defaults.baseURL = baseUrl;
+};
+
+export const customInstance = <TReturn>(
+  config: AxiosRequestConfig,
+  options?: AxiosRequestConfig,
+): Promise<TReturn> => {
+  const source = Axios.CancelToken.source();
+
+  const promise = AXIOS_INSTANCE({ ...config, ...options, cancelToken: source.token }).then(
+    ({ data }) => data,
+  );
+
+  // Promise doesn't have a cancel method but react-query requires this method to make cancellations general.
+  // This can either be a any assertion or a @ts-ignore comment.
+  (promise as any).cancel = () => {
+    source.cancel('Query was cancelled by React Query');
+  };
+
+  return promise;
+};
+
+export type ErrorType<TError> = AxiosError<TError>;

package/src/index.ts

@@ -0,0 +1,6 @@
+// Generated by orval
+// account-server-api Is replaced with the api name
+export * from './account-server-api.schemas';
+
+// Request instance and methods to change the baseUrl and auth token
+export * from './custom-instance';

package/src/organisation/organisation.ts

@@ -0,0 +1,181 @@
+/**
+ * Generated by orval v6.4.2 🍺
+ * Do not edit manually.
+ * Account Server API
+ * The Informatics Matters Account Server API.
+
+A service that provides access to the Account Server, which gives *registered* users access to and management of **Products**, **Organisations**, **Units** and **Users**.
+
+ * OpenAPI spec version: 0.1
+ */
+import {
+  useQuery,
+  useMutation,
+  UseQueryOptions,
+  UseMutationOptions,
+  QueryFunction,
+  MutationFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
+import type {
+  OrganisationsGetResponse,
+  AsError,
+  OrganisationPostResponse,
+  OrganisationPostBodyBody,
+} from "../account-server-api.schemas";
+import { customInstance, ErrorType } from ".././custom-instance";
+
+type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
+  ...args: any
+) => Promise<infer R>
+  ? R
+  : any;
+
+type SecondParameter<T extends (...args: any) => any> = T extends (
+  config: any,
+  args: infer P
+) => any
+  ? P
+  : never;
+
+/**
+ * Gets all the Organisations you are a member of. Admin users can see all Organisations
+
+ * @summary Gets Organisations
+ */
+export const getOrganisations = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<OrganisationsGetResponse>(
+    { url: `/organisation`, method: "get" },
+    options
+  );
+};
+
+export const getGetOrganisationsQueryKey = () => [`/organisation`];
+
+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
+ */
+export const createOrganisation = (
+  organisationPostBodyBody: OrganisationPostBodyBody,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<OrganisationPostResponse>(
+    { url: `/organisation`, method: "post", data: organisationPostBodyBody },
+    options
+  );
+};
+
+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
+ */
+export const deleteOrganisation = (
+  orgid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    { url: `/organisation/${orgid}`, method: "delete", data: undefined },
+    options
+  );
+};
+
+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);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof deleteOrganisation>,
+    TError,
+    { orgid: string },
+    TContext
+  >(mutationFn, mutationOptions);
+};

package/src/product/product.ts

@@ -0,0 +1,336 @@
+/**
+ * Generated by orval v6.4.2 🍺
+ * Do not edit manually.
+ * Account Server API
+ * The Informatics Matters Account Server API.
+
+A service that provides access to the Account Server, which gives *registered* users access to and management of **Products**, **Organisations**, **Units** and **Users**.
+
+ * OpenAPI spec version: 0.1
+ */
+import {
+  useQuery,
+  useMutation,
+  UseQueryOptions,
+  UseMutationOptions,
+  QueryFunction,
+  MutationFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
+import type {
+  ProductsGetTypesResponse,
+  AsError,
+  ProductsGetResponse,
+  UnitProductPostResponse,
+  UnitProductPostBodyBody,
+  ProductUnitGetResponse,
+  ProductPatchBodyBody,
+} from "../account-server-api.schemas";
+import { customInstance, ErrorType } from ".././custom-instance";
+
+type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
+  ...args: any
+) => Promise<infer R>
+  ? R
+  : any;
+
+type SecondParameter<T extends (...args: any) => any> = T extends (
+  config: any,
+  args: infer P
+) => any
+  ? P
+  : never;
+
+/**
+ * Gets product types you can purchase
+
+ * @summary Gets all Product Types
+ */
+export const getProductTypes = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ProductsGetTypesResponse>(
+    { url: `/product-type`, method: "get" },
+    options
+  );
+};
+
+export const getGetProductTypesQueryKey = () => [`/product-type`];
+
+export const useGetProductTypes = <
+  TData = AsyncReturnType<typeof getProductTypes>,
+  TError = ErrorType<AsError | void>
+>(options?: {
+  query?: UseQueryOptions<
+    AsyncReturnType<typeof getProductTypes>,
+    TError,
+    TData
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetProductTypesQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getProductTypes>> = () =>
+    getProductTypes(requestOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof getProductTypes>,
+    TError,
+    TData
+  >(queryKey, queryFn, queryOptions);
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Gets products you have access to, across all Units and Organisations
+
+ * @summary Gets all Products
+ */
+export const getProducts = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ProductsGetResponse>(
+    { url: `/product`, method: "get" },
+    options
+  );
+};
+
+export const getGetProductsQueryKey = () => [`/product`];
+
+export const useGetProducts = <
+  TData = AsyncReturnType<typeof getProducts>,
+  TError = ErrorType<AsError | void>
+>(options?: {
+  query?: UseQueryOptions<AsyncReturnType<typeof getProducts>, TError, TData>;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetProductsQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getProducts>> = () =>
+    getProducts(requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getProducts>, TError, TData>(
+    queryKey,
+    queryFn,
+    queryOptions
+  );
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * @summary Creates a Product for an Organisational Unit
+ */
+export const createUnitProduct = (
+  unitid: string,
+  unitProductPostBodyBody: UnitProductPostBodyBody,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<UnitProductPostResponse>(
+    {
+      url: `/product/unit/${unitid}`,
+      method: "post",
+      data: unitProductPostBodyBody,
+    },
+    options
+  );
+};
+
+export const useCreateUnitProduct = <
+  TError = ErrorType<AsError | void>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof createUnitProduct>,
+    TError,
+    { unitid: string; data: UnitProductPostBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof createUnitProduct>,
+    { unitid: string; data: UnitProductPostBodyBody }
+  > = (props) => {
+    const { unitid, data } = props || {};
+
+    return createUnitProduct(unitid, data, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof createUnitProduct>,
+    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
+ */
+export const getProductsForUnit = (
+  unitid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ProductsGetResponse>(
+    { url: `/product/unit/${unitid}`, method: "get" },
+    options
+  );
+};
+
+export const getGetProductsForUnitQueryKey = (unitid: string) => [
+  `/product/unit/${unitid}`,
+];
+
+export const useGetProductsForUnit = <
+  TData = AsyncReturnType<typeof getProductsForUnit>,
+  TError = ErrorType<void | AsError>
+>(
+  unitid: string,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof getProductsForUnit>,
+      TError,
+      TData
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getGetProductsForUnitQueryKey(unitid);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof getProductsForUnit>
+  > = () => getProductsForUnit(unitid, requestOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof getProductsForUnit>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!unitid, ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Gets a Unit's Product
+
+ * @summary Gets a Unit's Product
+ */
+export const getProduct = (
+  unitid: string,
+  productid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ProductUnitGetResponse>(
+    { url: `/product/unit/${unitid}/product/${productid}`, method: "get" },
+    options
+  );
+};
+
+export const getGetProductQueryKey = (unitid: string, productid: string) => [
+  `/product/unit/${unitid}/product/${productid}`,
+];
+
+export const useGetProduct = <
+  TData = AsyncReturnType<typeof getProduct>,
+  TError = ErrorType<AsError | void>
+>(
+  unitid: string,
+  productid: string,
+  options?: {
+    query?: UseQueryOptions<AsyncReturnType<typeof getProduct>, TError, TData>;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getGetProductQueryKey(unitid, productid);
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getProduct>> = () =>
+    getProduct(unitid, productid, requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getProduct>, TError, TData>(
+    queryKey,
+    queryFn,
+    { enabled: !!(unitid && productid), ...queryOptions }
+  );
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Used to update some adjustable parameters of a Product, i.e. to extend the Allowance or Limit. Curently you can only patch storage Products
+
+ * @summary Adjust an existing Product
+ */
+export const patchProduct = (
+  unitid: string,
+  productid: string,
+  productPatchBodyBody: ProductPatchBodyBody,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    {
+      url: `/product/unit/${unitid}/product/${productid}`,
+      method: "patch",
+      data: productPatchBodyBody,
+    },
+    options
+  );
+};
+
+export const usePatchProduct = <
+  TError = ErrorType<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof patchProduct>,
+    TError,
+    { unitid: string; productid: string; data: ProductPatchBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof patchProduct>,
+    { unitid: string; productid: string; data: ProductPatchBodyBody }
+  > = (props) => {
+    const { unitid, productid, data } = props || {};
+
+    return patchProduct(unitid, productid, data, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof patchProduct>,
+    TError,
+    { unitid: string; productid: string; data: ProductPatchBodyBody },
+    TContext
+  >(mutationFn, mutationOptions);
+};

package/src/service/service.ts

@@ -0,0 +1,124 @@
+/**
+ * Generated by orval v6.4.2 🍺
+ * Do not edit manually.
+ * Account Server API
+ * The Informatics Matters Account Server API.
+
+A service that provides access to the Account Server, which gives *registered* users access to and management of **Products**, **Organisations**, **Units** and **Users**.
+
+ * OpenAPI spec version: 0.1
+ */
+import {
+  useQuery,
+  UseQueryOptions,
+  QueryFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
+import type {
+  ServicesGetResponse,
+  AsError,
+  ServiceGetResponse,
+} from "../account-server-api.schemas";
+import { customInstance, ErrorType } from ".././custom-instance";
+
+type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
+  ...args: any
+) => Promise<infer R>
+  ? R
+  : any;
+
+type SecondParameter<T extends (...args: any) => any> = T extends (
+  config: any,
+  args: infer P
+) => any
+  ? P
+  : never;
+
+/**
+ * Gets services known to the Account Server
+
+ * @summary Gets all Services
+ */
+export const getServices = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ServicesGetResponse>(
+    { url: `/service`, method: "get" },
+    options
+  );
+};
+
+export const getGetServicesQueryKey = () => [`/service`];
+
+export const useGetServices = <
+  TData = AsyncReturnType<typeof getServices>,
+  TError = ErrorType<AsError | void>
+>(options?: {
+  query?: UseQueryOptions<AsyncReturnType<typeof getServices>, TError, TData>;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetServicesQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getServices>> = () =>
+    getServices(requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getServices>, TError, TData>(
+    queryKey,
+    queryFn,
+    queryOptions
+  );
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Gets a known service
+
+ * @summary Gets a specific Service
+ */
+export const getService = (
+  svcid: number,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ServiceGetResponse>(
+    { url: `/service/${svcid}`, method: "get" },
+    options
+  );
+};
+
+export const getGetServiceQueryKey = (svcid: number) => [`/service/${svcid}`];
+
+export const useGetService = <
+  TData = AsyncReturnType<typeof getService>,
+  TError = ErrorType<AsError | void>
+>(
+  svcid: number,
+  options?: {
+    query?: UseQueryOptions<AsyncReturnType<typeof getService>, TError, TData>;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetServiceQueryKey(svcid);
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getService>> = () =>
+    getService(svcid, requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getService>, TError, TData>(
+    queryKey,
+    queryFn,
+    { enabled: !!svcid, ...queryOptions }
+  );
+
+  return {
+    queryKey,
+    ...query,
+  };
+};