@squonk/account-server-client 4.9.0-beta.6 → 4.9.0-rc.2

package/src/api/api-schemas/index.ts

@@ -11,6 +11,7 @@
 
 export * from "./actionDetail";
 export * from "./actionGetResponse";
+export * from "./allCapabilitiesGetResponse";
 export * from "./asError";
 export * from "./assetDetail";
 export * from "./assetDetailScope";
@@ -61,6 +62,7 @@ export * from "./notificationDetailState";
 export * from "./notificationsGetResponse";
 export * from "./organisationAllDetail";
 export * from "./organisationAllDetailDefaultProductPrivacy";
+export * from "./organisationCapabilities";
 export * from "./organisationChargesGetResponse";
 export * from "./organisationChargeSummary";
 export * from "./organisationDetail";

package/src/api/api-schemas/organisationCapabilities.fetch.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.22.0 🍺
+ * 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 **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
+ *
+ * OpenAPI spec version: 4.9
+ */
+import type { CapabilityDetail } from "./capabilityDetail.fetch";
+
+export interface OrganisationCapabilities {
+  organisation_id: string;
+  name: string;
+  capabilities: CapabilityDetail[];
+}

package/src/api/api-schemas/organisationCapabilities.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.22.0 🍺
+ * 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 **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
+ *
+ * OpenAPI spec version: 4.9
+ */
+import type { CapabilityDetail } from "./capabilityDetail";
+
+export interface OrganisationCapabilities {
+  organisation_id: string;
+  name: string;
+  capabilities: CapabilityDetail[];
+}

package/src/api/capabilities/capabilities.fetch.ts

@@ -28,6 +28,7 @@ import type {
 } from "@tanstack/react-query";
 
 import type {
+  AllCapabilitiesGetResponse,
   AsError,
   CapabilitiesGetResponse,
   CapabilityPostBodyBody,
@@ -54,6 +55,246 @@ const withQueryKey = <T extends object, K>(query: T, queryKey: K): T & { queryKe
   return result;
 };
 
+export type getAllCapabilitiesResponse200 = { data: AllCapabilitiesGetResponse; status: 200 };
+
+export type getAllCapabilitiesResponse401 = { data: void; status: 401 };
+
+export type getAllCapabilitiesResponse403 = { data: AsError; status: 403 };
+
+export type getAllCapabilitiesResponseSuccess = getAllCapabilitiesResponse200 & {
+  headers: Headers;
+};
+export type getAllCapabilitiesResponseError = (
+  | getAllCapabilitiesResponse401
+  | getAllCapabilitiesResponse403
+) & { headers: Headers };
+
+export type getAllCapabilitiesResponse =
+  | getAllCapabilitiesResponseSuccess
+  | getAllCapabilitiesResponseError;
+
+export const getGetAllCapabilitiesUrl = () => {
+  return `/capability`;
+};
+
+/**
+ * Gets the Capabilities of all the Organisations, indexed by Organisation. Organisations without Capabilities are not included.
+ *
+ * You need admin rights to use this path.
+ * @summary Gets the Capabilities of all Organisations
+ */
+export const getAllCapabilities = async (
+  options?: RequestInit,
+): Promise<getAllCapabilitiesResponse> => {
+  return customFetch<getAllCapabilitiesResponse>(getGetAllCapabilitiesUrl(), {
+    ...options,
+    method: "GET",
+  });
+};
+
+export const getGetAllCapabilitiesQueryKey = () => {
+  return ["account-server", "capability"] as const;
+};
+
+export const getGetAllCapabilitiesQueryOptions = <
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>>;
+  request?: SecondParameter<typeof customFetch>;
+}) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetAllCapabilitiesQueryKey();
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getAllCapabilities>>> = ({ signal }) =>
+    getAllCapabilities({ signal, ...requestOptions });
+
+  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
+    Awaited<ReturnType<typeof getAllCapabilities>>,
+    TError,
+    TData
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+};
+
+export type GetAllCapabilitiesQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getAllCapabilities>>
+>;
+export type GetAllCapabilitiesQueryError = ErrorType<void | AsError>;
+
+export function useGetAllCapabilities<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>> &
+      Pick<
+        DefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getAllCapabilities>>,
+          TError,
+          Awaited<ReturnType<typeof getAllCapabilities>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetAllCapabilities<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+    > &
+      Pick<
+        UndefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getAllCapabilities>>,
+          TError,
+          Awaited<ReturnType<typeof getAllCapabilities>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetAllCapabilities<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>>;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+/**
+ * @summary Gets the Capabilities of all Organisations
+ */
+
+export function useGetAllCapabilities<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>>;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
+  const queryOptions = getGetAllCapabilitiesQueryOptions(options);
+
+  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+  };
+
+  return withQueryKey(query, queryOptions.queryKey);
+}
+
+/**
+ * @summary Gets the Capabilities of all Organisations
+ */
+export const invalidateGetAllCapabilities = async (
+  queryClient: QueryClient,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetAllCapabilitiesQueryKey() }, options);
+
+  return queryClient;
+};
+
+export const getGetAllCapabilitiesSuspenseQueryOptions = <
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: Partial<
+    UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+  >;
+  request?: SecondParameter<typeof customFetch>;
+}) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetAllCapabilitiesQueryKey();
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getAllCapabilities>>> = ({ signal }) =>
+    getAllCapabilities({ signal, ...requestOptions });
+
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
+    Awaited<ReturnType<typeof getAllCapabilities>>,
+    TError,
+    TData
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+};
+
+export type GetAllCapabilitiesSuspenseQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getAllCapabilities>>
+>;
+export type GetAllCapabilitiesSuspenseQueryError = ErrorType<void | AsError>;
+
+export function useGetAllCapabilitiesSuspense<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options: {
+    query: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetAllCapabilitiesSuspense<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetAllCapabilitiesSuspense<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+/**
+ * @summary Gets the Capabilities of all Organisations
+ */
+
+export function useGetAllCapabilitiesSuspense<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
+  const queryOptions = getGetAllCapabilitiesSuspenseQueryOptions(options);
+
+  const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
+    TData,
+    TError
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+
+  return withQueryKey(query, queryOptions.queryKey);
+}
+
 export type loadCapabilitiesResponse201 = { data: CapabilityPostResponse; status: 201 };
 
 export type loadCapabilitiesResponse400 = { data: AsError; status: 400 };

package/src/api/capabilities/capabilities.ts

@@ -28,6 +28,7 @@ import type {
 } from "@tanstack/react-query";
 
 import type {
+  AllCapabilitiesGetResponse,
   AsError,
   CapabilitiesGetResponse,
   CapabilityPostBodyBody,
@@ -54,6 +55,225 @@ const withQueryKey = <T extends object, K>(query: T, queryKey: K): T & { queryKe
   return result;
 };
 
+/**
+ * Gets the Capabilities of all the Organisations, indexed by Organisation. Organisations without Capabilities are not included.
+ *
+ * You need admin rights to use this path.
+ * @summary Gets the Capabilities of all Organisations
+ */
+export const getAllCapabilities = (
+  options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal,
+) => {
+  return customInstance<AllCapabilitiesGetResponse>(
+    { url: `/capability`, method: "GET", signal },
+    options,
+  );
+};
+
+export const getGetAllCapabilitiesQueryKey = () => {
+  return ["account-server", "capability"] as const;
+};
+
+export const getGetAllCapabilitiesQueryOptions = <
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>>;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetAllCapabilitiesQueryKey();
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getAllCapabilities>>> = ({ signal }) =>
+    getAllCapabilities(requestOptions, signal);
+
+  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
+    Awaited<ReturnType<typeof getAllCapabilities>>,
+    TError,
+    TData
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+};
+
+export type GetAllCapabilitiesQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getAllCapabilities>>
+>;
+export type GetAllCapabilitiesQueryError = ErrorType<void | AsError>;
+
+export function useGetAllCapabilities<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>> &
+      Pick<
+        DefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getAllCapabilities>>,
+          TError,
+          Awaited<ReturnType<typeof getAllCapabilities>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetAllCapabilities<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+    > &
+      Pick<
+        UndefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getAllCapabilities>>,
+          TError,
+          Awaited<ReturnType<typeof getAllCapabilities>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetAllCapabilities<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+/**
+ * @summary Gets the Capabilities of all Organisations
+ */
+
+export function useGetAllCapabilities<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
+  const queryOptions = getGetAllCapabilitiesQueryOptions(options);
+
+  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+  };
+
+  return withQueryKey(query, queryOptions.queryKey);
+}
+
+/**
+ * @summary Gets the Capabilities of all Organisations
+ */
+export const invalidateGetAllCapabilities = async (
+  queryClient: QueryClient,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetAllCapabilitiesQueryKey() }, options);
+
+  return queryClient;
+};
+
+export const getGetAllCapabilitiesSuspenseQueryOptions = <
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: Partial<
+    UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetAllCapabilitiesQueryKey();
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getAllCapabilities>>> = ({ signal }) =>
+    getAllCapabilities(requestOptions, signal);
+
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
+    Awaited<ReturnType<typeof getAllCapabilities>>,
+    TError,
+    TData
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+};
+
+export type GetAllCapabilitiesSuspenseQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getAllCapabilities>>
+>;
+export type GetAllCapabilitiesSuspenseQueryError = ErrorType<void | AsError>;
+
+export function useGetAllCapabilitiesSuspense<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options: {
+    query: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetAllCapabilitiesSuspense<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetAllCapabilitiesSuspense<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+/**
+ * @summary Gets the Capabilities of all Organisations
+ */
+
+export function useGetAllCapabilitiesSuspense<
+  TData = Awaited<ReturnType<typeof getAllCapabilities>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getAllCapabilities>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
+  const queryOptions = getGetAllCapabilitiesSuspenseQueryOptions(options);
+
+  const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
+    TData,
+    TError
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+
+  return withQueryKey(query, queryOptions.queryKey);
+}
+
 /**
  * Loads the Capabilities defined in a YAML file against an Organisation. Several Capabilities can be loaded at once by concatenating their definitions (as separate YAML documents). Either all the Capabilities in the file are loaded or none of them are.
  *