@squonk/account-server-client 4.7.0-trunk.2383504127 → 4.7.2

package/src/api/event-stream/event-stream.fetch.ts

@@ -1,11 +1,11 @@
 /**
- * Generated by orval v7.17.0 🍺
+ * 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**.
-
+ *
+ * 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.7
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
@@ -32,18 +32,28 @@ import type {
   EventStreamGetPostResponse,
   EventStreamPostBodyBody,
   EventStreamVersionGetResponse,
-} from ".././api-schemas";
+} from "../api-schemas";
 
 import { customFetch } from "../../custom-fetch";
 import type { ErrorType } from "../../custom-fetch";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
-/**
- * Gets the details of the installed event stream, which includes its **protocol**, and **name**.
+const withQueryKey = <T extends object, K>(query: T, queryKey: K): T & { queryKey: K } => {
+  const result = { queryKey } as T & { queryKey: K };
+  for (const key of Object.keys(query)) {
+    // The explicit queryKey always wins, matching the previous
+    // `{ ...query, queryKey }` spread where it was set last.
+    if (key === "queryKey") continue;
+    Object.defineProperty(result, key, {
+      enumerable: true,
+      configurable: true,
+      get: () => (query as Record<string, unknown>)[key],
+    });
+  }
+  return result;
+};
 
- * @summary Gets the details of the installed event stream
- */
 export type getEventStreamVersionResponse200 = { data: EventStreamVersionGetResponse; status: 200 };
 
 export type getEventStreamVersionResponse401 = { data: void; status: 401 };
@@ -66,6 +76,10 @@ export const getGetEventStreamVersionUrl = () => {
   return `/event-stream/version`;
 };
 
+/**
+ * Gets the details of the installed event stream, which includes its **protocol**, and **name**.
+ * @summary Gets the details of the installed event stream
+ */
 export const getEventStreamVersion = async (
   options?: RequestInit,
 ): Promise<getEventStreamVersionResponse> => {
@@ -99,7 +113,7 @@ export const getGetEventStreamVersionQueryOptions = <
     Awaited<ReturnType<typeof getEventStreamVersion>>,
     TError,
     TData
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 };
 
 export type GetEventStreamVersionQueryResult = NonNullable<
@@ -126,7 +140,7 @@ export function useGetEventStreamVersion<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetEventStreamVersion<
   TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
   TError = ErrorType<void | AsError>,
@@ -146,7 +160,7 @@ export function useGetEventStreamVersion<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetEventStreamVersion<
   TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
   TError = ErrorType<void | AsError>,
@@ -158,7 +172,7 @@ export function useGetEventStreamVersion<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Gets the details of the installed event stream
  */
@@ -174,16 +188,14 @@ export function useGetEventStreamVersion<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
   const queryOptions = getGetEventStreamVersionQueryOptions(options);
 
   const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
-    queryKey: DataTag<QueryKey, TData>;
+    queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  query.queryKey = queryOptions.queryKey;
-
-  return query;
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -218,7 +230,7 @@ export const getGetEventStreamVersionSuspenseQueryOptions = <
     Awaited<ReturnType<typeof getEventStreamVersion>>,
     TError,
     TData
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 };
 
 export type GetEventStreamVersionSuspenseQueryResult = NonNullable<
@@ -237,7 +249,7 @@ export function useGetEventStreamVersionSuspense<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetEventStreamVersionSuspense<
   TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
   TError = ErrorType<void | AsError>,
@@ -249,7 +261,7 @@ export function useGetEventStreamVersionSuspense<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetEventStreamVersionSuspense<
   TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
   TError = ErrorType<void | AsError>,
@@ -261,7 +273,7 @@ export function useGetEventStreamVersionSuspense<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Gets the details of the installed event stream
  */
@@ -277,24 +289,17 @@ export function useGetEventStreamVersionSuspense<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
   const queryOptions = getGetEventStreamVersionSuspenseQueryOptions(options);
 
   const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
     TData,
     TError
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  query.queryKey = queryOptions.queryKey;
-
-  return query;
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
-/**
- * Gets the details of your event stream, if you have created one. The response includes the event stream **id** and the **location** where events can be accessed.
-
- * @summary Gets the details of your event stream
- */
 export type getEventStreamResponse200 = { data: EventStreamGetPostResponse; status: 200 };
 
 export type getEventStreamResponse401 = { data: void; status: 401 };
@@ -313,6 +318,10 @@ export const getGetEventStreamUrl = () => {
   return `/event-stream`;
 };
 
+/**
+ * Gets the details of your event stream, if you have created one. The response includes the event stream **id** and the **location** where events can be accessed.
+ * @summary Gets the details of your event stream
+ */
 export const getEventStream = async (options?: RequestInit): Promise<getEventStreamResponse> => {
   return customFetch<getEventStreamResponse>(getGetEventStreamUrl(), { ...options, method: "GET" });
 };
@@ -339,7 +348,7 @@ export const getGetEventStreamQueryOptions = <
     Awaited<ReturnType<typeof getEventStream>>,
     TError,
     TData
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 };
 
 export type GetEventStreamQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStream>>>;
@@ -362,7 +371,7 @@ export function useGetEventStream<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetEventStream<
   TData = Awaited<ReturnType<typeof getEventStream>>,
   TError = ErrorType<void | AsError>,
@@ -380,7 +389,7 @@ export function useGetEventStream<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetEventStream<
   TData = Awaited<ReturnType<typeof getEventStream>>,
   TError = ErrorType<void | AsError>,
@@ -390,7 +399,7 @@ export function useGetEventStream<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Gets the details of your event stream
  */
@@ -404,16 +413,14 @@ export function useGetEventStream<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
   const queryOptions = getGetEventStreamQueryOptions(options);
 
   const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
-    queryKey: DataTag<QueryKey, TData>;
+    queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  query.queryKey = queryOptions.queryKey;
-
-  return query;
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -448,7 +455,7 @@ export const getGetEventStreamSuspenseQueryOptions = <
     Awaited<ReturnType<typeof getEventStream>>,
     TError,
     TData
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 };
 
 export type GetEventStreamSuspenseQueryResult = NonNullable<
@@ -467,7 +474,7 @@ export function useGetEventStreamSuspense<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetEventStreamSuspense<
   TData = Awaited<ReturnType<typeof getEventStream>>,
   TError = ErrorType<void | AsError>,
@@ -479,7 +486,7 @@ export function useGetEventStreamSuspense<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetEventStreamSuspense<
   TData = Awaited<ReturnType<typeof getEventStream>>,
   TError = ErrorType<void | AsError>,
@@ -491,7 +498,7 @@ export function useGetEventStreamSuspense<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Gets the details of your event stream
  */
@@ -507,32 +514,17 @@ export function useGetEventStreamSuspense<
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
   const queryOptions = getGetEventStreamSuspenseQueryOptions(options);
 
   const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
     TData,
     TError
-  > & { queryKey: DataTag<QueryKey, TData> };
-
-  query.queryKey = queryOptions.queryKey;
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return query;
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
-/**
- * Creates a new event stream for the authenticated user. Event streams deliver near-real-time events to the user, typically through a long-running *Socket*. The protocol is dependent on the Event Stream Service that has been installed. Our **Python FastAPI WebSocket** service is one such service.
-
-Events are delivered to the client using the a `format` chosen here. Internally, events are **Protocol Buffer** objects that are delivered, by default as a single-line string using `MessageToString`. This is the `PROTOCOL_STRING` format. Clients can choose to receive messages as a JSON string using the format `JSON_STRING`. Using JSON strings will incur a small processing penalty but they are useful if the client does not have access to a library that can decode protocol buffer strings.
-
-The response will include the event stream **id** and the **location** where events can be accessed.
-
-The event streaming service is an optional component of the Account Server. If a service is not installed you will receive a corresponding **404** error response.
-
-A user is only permitted one event stream.
-
- * @summary Create a new event stream
- */
 export type createEventStreamResponse201 = { data: EventStreamGetPostResponse; status: 201 };
 
 export type createEventStreamResponse400 = { data: AsError; status: 400 };
@@ -559,6 +551,18 @@ export const getCreateEventStreamUrl = () => {
   return `/event-stream`;
 };
 
+/**
+ * Creates a new event stream for the authenticated user. Event streams deliver near-real-time events to the user, typically through a long-running *Socket*. The protocol is dependent on the Event Stream Service that has been installed. Our **Python FastAPI WebSocket** service is one such service.
+ *
+ * Events are delivered to the client using the a `format` chosen here. Internally, events are **Protocol Buffer** objects that are delivered, by default as a single-line string using `MessageToString`. This is the `PROTOCOL_STRING` format. Clients can choose to receive messages as a JSON string using the format `JSON_STRING`. Using JSON strings will incur a small processing penalty but they are useful if the client does not have access to a library that can decode protocol buffer strings.
+ *
+ * The response will include the event stream **id** and the **location** where events can be accessed.
+ *
+ * The event streaming service is an optional component of the Account Server. If a service is not installed you will receive a corresponding **404** error response.
+ *
+ * A user is only permitted one event stream.
+ * @summary Create a new event stream
+ */
 export const createEventStream = async (
   eventStreamPostBodyBody: EventStreamPostBodyBody,
   options?: RequestInit,
@@ -633,15 +637,8 @@ export const useCreateEventStream = <TError = ErrorType<AsError | void>, TContex
   { data: EventStreamPostBodyBody },
   TContext
 > => {
-  const mutationOptions = getCreateEventStreamMutationOptions(options);
-
-  return useMutation(mutationOptions, queryClient);
+  return useMutation(getCreateEventStreamMutationOptions(options), queryClient);
 };
-/**
- * You must be the user who created the event stream.
-
- * @summary Deletes an existing event stream (that you created)
- */
 export type deleteEventStreamResponse204 = { data: void; status: 204 };
 
 export type deleteEventStreamResponse401 = { data: void; status: 401 };
@@ -665,6 +662,10 @@ export const getDeleteEventStreamUrl = (eventStreamId: number) => {
   return `/event-stream/${eventStreamId}`;
 };
 
+/**
+ * You must be the user who created the event stream.
+ * @summary Deletes an existing event stream (that you created)
+ */
 export const deleteEventStream = async (
   eventStreamId: number,
   options?: RequestInit,
@@ -737,7 +738,5 @@ export const useDeleteEventStream = <TError = ErrorType<void | AsError>, TContex
   { eventStreamId: number },
   TContext
 > => {
-  const mutationOptions = getDeleteEventStreamMutationOptions(options);
-
-  return useMutation(mutationOptions, queryClient);
+  return useMutation(getDeleteEventStreamMutationOptions(options), queryClient);
 };