@squonk/account-server-client 4.4.0-4-4.2197467763 → 4.4.0-4-4.2200269934

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

@@ -10,11 +10,15 @@ A service that provides access to the Account Server, which gives *registered* u
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
+  DataTag,
+  DefinedInitialDataOptions,
+  DefinedUseQueryResult,
   InvalidateOptions,
   MutationFunction,
   QueryClient,
   QueryFunction,
   QueryKey,
+  UndefinedInitialDataOptions,
   UseMutationOptions,
   UseMutationResult,
   UseQueryOptions,
@@ -58,7 +62,9 @@ export const getGetEventStreamVersionQueryOptions = <
   TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
   TError = ErrorType<void | AsError>,
 >(options?: {
-  query?: UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>;
+  query?: Partial<
+    UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>
+  >;
   request?: SecondParameter<typeof customInstance>;
 }) => {
   const { query: queryOptions, request: requestOptions } = options ?? {};
@@ -72,7 +78,7 @@ export const getGetEventStreamVersionQueryOptions = <
     Awaited<ReturnType<typeof getEventStreamVersion>>,
     TError,
     TData
-  > & { queryKey: QueryKey };
+  > & { queryKey: DataTag<QueryKey, TData> };
 };
 
 export type GetEventStreamVersionQueryResult = NonNullable<
@@ -80,6 +86,58 @@ export type GetEventStreamVersionQueryResult = NonNullable<
 >;
 export type GetEventStreamVersionQueryError = ErrorType<void | AsError>;
 
+export function useGetEventStreamVersion<
+  TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options: {
+    query: Partial<
+      UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>
+    > &
+      Pick<
+        DefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getEventStreamVersion>>,
+          TError,
+          Awaited<ReturnType<typeof getEventStreamVersion>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetEventStreamVersion<
+  TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>
+    > &
+      Pick<
+        UndefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getEventStreamVersion>>,
+          TError,
+          Awaited<ReturnType<typeof getEventStreamVersion>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetEventStreamVersion<
+  TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
 /**
  * @summary Gets the details of the installed event stream
  */
@@ -87,13 +145,20 @@ export type GetEventStreamVersionQueryError = ErrorType<void | AsError>;
 export function useGetEventStreamVersion<
   TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
   TError = ErrorType<void | AsError>,
->(options?: {
-  query?: UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>;
-  request?: SecondParameter<typeof customInstance>;
-}): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+>(
+  options?: {
+    query?: Partial<
+      UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
   const queryOptions = getGetEventStreamVersionQueryOptions(options);
 
-  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
+  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData>;
+  };
 
   query.queryKey = queryOptions.queryKey;
 
@@ -116,7 +181,9 @@ export const getGetEventStreamVersionSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
   TError = ErrorType<void | AsError>,
 >(options?: {
-  query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>;
+  query?: Partial<
+    UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>
+  >;
   request?: SecondParameter<typeof customInstance>;
 }) => {
   const { query: queryOptions, request: requestOptions } = options ?? {};
@@ -130,7 +197,7 @@ export const getGetEventStreamVersionSuspenseQueryOptions = <
     Awaited<ReturnType<typeof getEventStreamVersion>>,
     TError,
     TData
-  > & { queryKey: QueryKey };
+  > & { queryKey: DataTag<QueryKey, TData> };
 };
 
 export type GetEventStreamVersionSuspenseQueryResult = NonNullable<
@@ -138,6 +205,42 @@ export type GetEventStreamVersionSuspenseQueryResult = NonNullable<
 >;
 export type GetEventStreamVersionSuspenseQueryError = ErrorType<void | AsError>;
 
+export function useGetEventStreamVersionSuspense<
+  TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options: {
+    query: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetEventStreamVersionSuspense<
+  TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetEventStreamVersionSuspense<
+  TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
 /**
  * @summary Gets the details of the installed event stream
  */
@@ -145,15 +248,21 @@ export type GetEventStreamVersionSuspenseQueryError = ErrorType<void | AsError>;
 export function useGetEventStreamVersionSuspense<
   TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
   TError = ErrorType<void | AsError>,
->(options?: {
-  query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>;
-  request?: SecondParameter<typeof customInstance>;
-}): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
   const queryOptions = getGetEventStreamVersionSuspenseQueryOptions(options);
 
-  const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
-  };
+  const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
+    TData,
+    TError
+  > & { queryKey: DataTag<QueryKey, TData> };
 
   query.queryKey = queryOptions.queryKey;
 
@@ -183,7 +292,7 @@ export const getGetEventStreamQueryOptions = <
   TData = Awaited<ReturnType<typeof getEventStream>>,
   TError = ErrorType<void | AsError>,
 >(options?: {
-  query?: UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>;
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>;
   request?: SecondParameter<typeof customInstance>;
 }) => {
   const { query: queryOptions, request: requestOptions } = options ?? {};
@@ -197,12 +306,58 @@ export const getGetEventStreamQueryOptions = <
     Awaited<ReturnType<typeof getEventStream>>,
     TError,
     TData
-  > & { queryKey: QueryKey };
+  > & { queryKey: DataTag<QueryKey, TData> };
 };
 
 export type GetEventStreamQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStream>>>;
 export type GetEventStreamQueryError = ErrorType<void | AsError>;
 
+export function useGetEventStream<
+  TData = Awaited<ReturnType<typeof getEventStream>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>> &
+      Pick<
+        DefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getEventStream>>,
+          TError,
+          Awaited<ReturnType<typeof getEventStream>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetEventStream<
+  TData = Awaited<ReturnType<typeof getEventStream>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>> &
+      Pick<
+        UndefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getEventStream>>,
+          TError,
+          Awaited<ReturnType<typeof getEventStream>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetEventStream<
+  TData = Awaited<ReturnType<typeof getEventStream>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
 /**
  * @summary Gets the details of your event stream
  */
@@ -210,13 +365,18 @@ export type GetEventStreamQueryError = ErrorType<void | AsError>;
 export function useGetEventStream<
   TData = Awaited<ReturnType<typeof getEventStream>>,
   TError = ErrorType<void | AsError>,
->(options?: {
-  query?: UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>;
-  request?: SecondParameter<typeof customInstance>;
-}): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+>(
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
   const queryOptions = getGetEventStreamQueryOptions(options);
 
-  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
+  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData>;
+  };
 
   query.queryKey = queryOptions.queryKey;
 
@@ -239,7 +399,9 @@ export const getGetEventStreamSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getEventStream>>,
   TError = ErrorType<void | AsError>,
 >(options?: {
-  query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>;
+  query?: Partial<
+    UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>
+  >;
   request?: SecondParameter<typeof customInstance>;
 }) => {
   const { query: queryOptions, request: requestOptions } = options ?? {};
@@ -253,7 +415,7 @@ export const getGetEventStreamSuspenseQueryOptions = <
     Awaited<ReturnType<typeof getEventStream>>,
     TError,
     TData
-  > & { queryKey: QueryKey };
+  > & { queryKey: DataTag<QueryKey, TData> };
 };
 
 export type GetEventStreamSuspenseQueryResult = NonNullable<
@@ -261,6 +423,42 @@ export type GetEventStreamSuspenseQueryResult = NonNullable<
 >;
 export type GetEventStreamSuspenseQueryError = ErrorType<void | AsError>;
 
+export function useGetEventStreamSuspense<
+  TData = Awaited<ReturnType<typeof getEventStream>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options: {
+    query: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetEventStreamSuspense<
+  TData = Awaited<ReturnType<typeof getEventStream>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetEventStreamSuspense<
+  TData = Awaited<ReturnType<typeof getEventStream>>,
+  TError = ErrorType<void | AsError>,
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
 /**
  * @summary Gets the details of your event stream
  */
@@ -268,15 +466,21 @@ export type GetEventStreamSuspenseQueryError = ErrorType<void | AsError>;
 export function useGetEventStreamSuspense<
   TData = Awaited<ReturnType<typeof getEventStream>>,
   TError = ErrorType<void | AsError>,
->(options?: {
-  query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>;
-  request?: SecondParameter<typeof customInstance>;
-}): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
+>(
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
   const queryOptions = getGetEventStreamSuspenseQueryOptions(options);
 
-  const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
-  };
+  const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
+    TData,
+    TError
+  > & { queryKey: DataTag<QueryKey, TData> };
 
   query.queryKey = queryOptions.queryKey;
 
@@ -358,18 +562,18 @@ export type CreateEventStreamMutationError = ErrorType<AsError | void>;
 /**
  * @summary Create a new event stream
  */
-export const useCreateEventStream = <
-  TError = ErrorType<AsError | void>,
-  TContext = unknown,
->(options?: {
-  mutation?: UseMutationOptions<
-    Awaited<ReturnType<typeof createEventStream>>,
-    TError,
-    { data: EventStreamPostBodyBody },
-    TContext
-  >;
-  request?: SecondParameter<typeof customInstance>;
-}): UseMutationResult<
+export const useCreateEventStream = <TError = ErrorType<AsError | void>, TContext = unknown>(
+  options?: {
+    mutation?: UseMutationOptions<
+      Awaited<ReturnType<typeof createEventStream>>,
+      TError,
+      { data: EventStreamPostBodyBody },
+      TContext
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseMutationResult<
   Awaited<ReturnType<typeof createEventStream>>,
   TError,
   { data: EventStreamPostBodyBody },
@@ -377,7 +581,7 @@ export const useCreateEventStream = <
 > => {
   const mutationOptions = getCreateEventStreamMutationOptions(options);
 
-  return useMutation(mutationOptions);
+  return useMutation(mutationOptions, queryClient);
 };
 /**
  * You must be the user who created the event stream.
@@ -436,18 +640,18 @@ export type DeleteEventStreamMutationError = ErrorType<void | AsError>;
 /**
  * @summary Deletes an existing event stream (that you created)
  */
-export const useDeleteEventStream = <
-  TError = ErrorType<void | AsError>,
-  TContext = unknown,
->(options?: {
-  mutation?: UseMutationOptions<
-    Awaited<ReturnType<typeof deleteEventStream>>,
-    TError,
-    { eventStreamId: number },
-    TContext
-  >;
-  request?: SecondParameter<typeof customInstance>;
-}): UseMutationResult<
+export const useDeleteEventStream = <TError = ErrorType<void | AsError>, TContext = unknown>(
+  options?: {
+    mutation?: UseMutationOptions<
+      Awaited<ReturnType<typeof deleteEventStream>>,
+      TError,
+      { eventStreamId: number },
+      TContext
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseMutationResult<
   Awaited<ReturnType<typeof deleteEventStream>>,
   TError,
   { eventStreamId: number },
@@ -455,5 +659,5 @@ export const useDeleteEventStream = <
 > => {
   const mutationOptions = getDeleteEventStreamMutationOptions(options);
 
-  return useMutation(mutationOptions);
+  return useMutation(mutationOptions, queryClient);
 };