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

package/src/account-server-api.schemas.ts

@@ -0,0 +1,278 @@
+/**
+ * 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
+ */
+/**
+ * A dummy
+
+ */
+export type QDummyParameter = boolean;
+
+export type ProductPatchBodyBody = {
+  /** The name you want to give the Product */
+  name?: string;
+  /** The Product's built-in coin alloance. */
+  allowance?: number;
+  /** The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used */
+  limit?: number;
+};
+
+/**
+ * The Flavour of the Product. Used only for Project Tier Products. Do nto set this for Storage products
+ */
+export type UnitProductPostBodyBodyFlavour =
+  | "EVALUATION"
+  | "BRONZE"
+  | "SILVER"
+  | "GOLD";
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const UnitProductPostBodyBodyFlavour = {
+  EVALUATION: "EVALUATION" as UnitProductPostBodyBodyFlavour,
+  BRONZE: "BRONZE" as UnitProductPostBodyBodyFlavour,
+  SILVER: "SILVER" as UnitProductPostBodyBodyFlavour,
+  GOLD: "GOLD" as UnitProductPostBodyBodyFlavour,
+};
+
+/**
+ * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be providec. Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products
+ */
+export type UnitProductPostBodyBodyType =
+  | "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION"
+  | "DATA_MANAGER_STORAGE_SUBSCRIPTION";
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const UnitProductPostBodyBodyType = {
+  DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:
+    "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION" as UnitProductPostBodyBodyType,
+  DATA_MANAGER_STORAGE_SUBSCRIPTION:
+    "DATA_MANAGER_STORAGE_SUBSCRIPTION" as UnitProductPostBodyBodyType,
+};
+
+export type UnitProductPostBodyBody = {
+  /** The name you want to give the Product */
+  name: string;
+  /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be providec. Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */
+  type: UnitProductPostBodyBodyType;
+  /** The Flavour of the Product. Used only for Project Tier Products. Do nto set this for Storage products */
+  flavour?: UnitProductPostBodyBodyFlavour;
+  /** The Product's coin alloance. You must provide this for Storage products but you must not provide a value for Project Tier Products */
+  allowance?: number;
+  /** The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. You can provide this for Storage products but you must not provide a value for Project Tier Products */
+  limit?: number;
+  /** The day you would like to be billed for the Product's subscription (a value from 1 and 28) */
+  billing_day: number;
+};
+
+export type OrganisationUnitPostBodyBody = {
+  /** The name of the unit */
+  name: string;
+};
+
+export type OrganisationPostBodyBody = {
+  /** The name of the organisaion */
+  name: string;
+  /** The name of the organisation owner. A user ID */
+  owner: string;
+};
+
+export interface UserDetail {
+  id: string;
+}
+
+export interface UnitDetail {
+  id: string;
+  name: string;
+  owner_id?: string;
+}
+
+export interface OrganisationDetail {
+  id: string;
+  name: string;
+  owner_id?: string;
+}
+
+export type ProductInstanceDetailCoins = {
+  used: number;
+};
+
+export interface ProductInstanceDetail {
+  coins: ProductInstanceDetailCoins;
+}
+
+export type ProductDetailFlavour = "EVALUATION" | "BRONZE" | "SILVER" | "GOLD";
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ProductDetailFlavour = {
+  EVALUATION: "EVALUATION" as ProductDetailFlavour,
+  BRONZE: "BRONZE" as ProductDetailFlavour,
+  SILVER: "SILVER" as ProductDetailFlavour,
+  GOLD: "GOLD" as ProductDetailFlavour,
+};
+
+export type ProductDetailType =
+  | "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION"
+  | "DATA_MANAGER_STORAGE_SUBSCRIPTION";
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ProductDetailType = {
+  DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:
+    "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION" as ProductDetailType,
+  DATA_MANAGER_STORAGE_SUBSCRIPTION:
+    "DATA_MANAGER_STORAGE_SUBSCRIPTION" as ProductDetailType,
+};
+
+export interface ProductDetail {
+  /** The Product ID
+   */
+  id: string;
+  type: ProductDetailType;
+  flavour?: ProductDetailFlavour;
+  name?: string;
+}
+
+export interface ProductCoinsDetail {
+  /** The billing allowance. When you exceed this during the current billign period the *cost multipler* will increase */
+  allowance: number;
+  /** The limit on your billing period spend. You can exceed the allowance but you cannot exceed the spend limit. Once reached the dependent may be restricted */
+  limit: number;
+  /** The total number of coins consumed (in this billing period), exclding the coins that have been consumed for the current day */
+  used: number;
+  /** True if the product is oeprating at or beyond its coin limit. When it is authority to perform actions using the product are severly limited. */
+  at_limit: boolean;
+  /** The current burn rate, the approximate amount of coins you are currently consuming each day */
+  current_burn_rate: number;
+  /** The predicted billing period amount, if costs continue at the current burn rate until the end of the billing period */
+  billing_prediction: number;
+  /** The day of the month when the bill is due, and the end of the current billign period */
+  billing_day: number;
+  /** A multipler applied to your coin usage within yoru allowance */
+  allowance_multiplier: number;
+  /** A multipler that will be applied to coin used beyond your allowance */
+  overspend_multiplier: number;
+  /** The number of days remaining, in the current billing period */
+  remaining_days: number;
+}
+
+export interface ProductClaimDetail {
+  /** The service ID using this Subscription.
+   */
+  id: string;
+  /** A name for the service
+   */
+  name?: string;
+}
+
+export type ProductDmStorageDetailCoins = {
+  /** The number of coins currently committed for the current day. This is added to the acumulated coins at the start of each day */
+  used: number;
+  /** The coin cost of a 'unit' of strage or part thereof. The unit size is defined in the storage section of the response */
+  unit_cost: number;
+};
+
+export type ProductDmStorageDetailSize = {
+  /** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */
+  peak: string;
+  /** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */
+  current: string;
+  /** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */
+  unit_size: string;
+  /** The peak number of storage units used today */
+  units_used: number;
+};
+
+export interface ProductDmStorageDetail {
+  size: ProductDmStorageDetailSize;
+  coins: ProductDmStorageDetailCoins;
+}
+
+export interface ProductDmProjectTier {
+  product: ProductDetail;
+  organisation: OrganisationDetail;
+  unit: UnitDetail;
+  storage: ProductDmStorageDetail;
+  coins: ProductCoinsDetail;
+  instance: ProductInstanceDetail;
+  claim?: ProductClaimDetail;
+}
+
+export interface ProductDmStorage {
+  product: ProductDetail;
+  organisation: OrganisationDetail;
+  unit: UnitDetail;
+  storage: ProductDmStorageDetail;
+  coins: ProductCoinsDetail;
+}
+
+export interface UnitsGetResponse {
+  /** A list of Units
+   */
+  units: OrganisationUnitsGetResponse[];
+}
+
+export interface UnitProductPostResponse {
+  /** The products's unique ID */
+  id: string;
+}
+
+/**
+ * The Unit's Product
+ */
+export type ProductUnitGetResponseProduct =
+  | ProductDmStorage
+  | ProductDmProjectTier;
+
+export interface ProductUnitGetResponse {
+  /** The Unit's Product */
+  product: ProductUnitGetResponseProduct;
+}
+
+export type ProductsGetResponseProductsItem =
+  | ProductDmStorage
+  | ProductDmProjectTier;
+
+export interface ProductsGetResponse {
+  /** All the Products you have access to */
+  products: ProductsGetResponseProductsItem[];
+}
+
+export interface OrganisationsGetResponse {
+  /** A list of Organisaions */
+  organisations: OrganisationDetail[];
+}
+
+export interface OrganisationUnitsGetResponse {
+  organisation: OrganisationDetail;
+  /** A list of Units
+   */
+  units: UnitDetail[];
+}
+
+export interface OrganisationUnitPostResponse {
+  /** The unit's unique ID */
+  id: string;
+}
+
+export interface UsersGetResponse {
+  organisation?: OrganisationDetail;
+  unit?: UnitDetail;
+  /** The list of Organisation Users
+   */
+  users: UserDetail[];
+}
+
+export interface OrganisationPostResponse {
+  /** The organisation's unique ID */
+  id: string;
+}
+
+export interface AsError {
+  /** Brief error text that can be presented to the user */
+  error: string;
+}

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);
+};