@squonk/account-server-client 2.1.0-rc.1 → 2.1.0-rc.10

package/src/custom-instance.ts

@@ -39,10 +39,9 @@ export const customInstance = <TReturn>(
     ({ 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');
+  // @ts-expect-error need to add a cancel method to the promise
+  promise.cancel = () => {
+    source.cancel('Query was cancelled');
   };
 
   return promise;

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

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.15.0 🍺
+ * Generated by orval v6.25.0 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
@@ -8,29 +8,31 @@ A service that provides access to the Account Server, which gives *registered* u
 
  * OpenAPI spec version: 2.1
  */
-import { useQuery, useMutation } from "@tanstack/react-query";
+import {
+  useMutation,
+  useQuery,
+  useSuspenseQuery
+} from '@tanstack/react-query'
 import type {
-  UseQueryOptions,
-  UseMutationOptions,
-  QueryFunction,
   MutationFunction,
-  UseQueryResult,
+  QueryFunction,
   QueryKey,
-} from "@tanstack/react-query";
+  UseMutationOptions,
+  UseQueryOptions,
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult
+} from '@tanstack/react-query'
 import type {
-  EventStreamGetPostResponse,
   AsError,
-} from "../account-server-api.schemas";
-import { customInstance } from ".././custom-instance";
-import type { ErrorType } from ".././custom-instance";
-
-// eslint-disable-next-line
-type SecondParameter<T extends (...args: any) => any> = T extends (
-  config: any,
-  args: infer P
-) => any
-  ? P
-  : never;
+  EventStreamGetPostResponse
+} from '../account-server-api.schemas'
+import { customInstance } from '.././custom-instance';
+import type { ErrorType } from '.././custom-instance';
+
+
+type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
+
 
 /**
  * Gets your EventStream ID and read token, if you have created one.
@@ -38,69 +40,102 @@ type SecondParameter<T extends (...args: any) => any> = T extends (
  * @summary Gets the details of your EventStream
  */
 export const getEventStream = (
-  options?: SecondParameter<typeof customInstance>,
-  signal?: AbortSignal
+    
+ options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
+) => {
+      
+      
+      return customInstance<EventStreamGetPostResponse>(
+      {url: `/event-stream`, method: 'GET', signal
+    },
+      options);
+    }
+  
+
+export const getGetEventStreamQueryKey = () => {
+    return ["account-server-api", `/event-stream`] as const;
+    }
+
+    
+export const getGetEventStreamQueryOptions = <TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamQueryKey();
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStream>>> = ({ signal }) => getEventStream(requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetEventStreamQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStream>>>
+export type GetEventStreamQueryError = ErrorType<void | AsError>
+
+/**
+ * @summary Gets the details of your EventStream
+ */
+export const useGetEventStream = <TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetEventStreamQueryOptions(options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+export const getGetEventStreamSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
-  return customInstance<EventStreamGetPostResponse>(
-    { url: `/event-stream`, method: "get", signal },
-    options
-  );
-};
-
-export const getGetEventStreamQueryKey = () => ["account-server-api", `/event-stream`] as const;
-
-export const getGetEventStreamQueryOptions = <
-  TData = Awaited<ReturnType<typeof getEventStream>>,
-  TError = ErrorType<void | AsError>
->(options?: {
-  query?: UseQueryOptions<
-    Awaited<ReturnType<typeof getEventStream>>,
-    TError,
-    TData
-  >;
-  request?: SecondParameter<typeof customInstance>;
-}): UseQueryOptions<
-  Awaited<ReturnType<typeof getEventStream>>,
-  TError,
-  TData
-> & { queryKey: QueryKey } => {
-  const { query: queryOptions, request: requestOptions } = options ?? {};
-
-  const queryKey = queryOptions?.queryKey ?? getGetEventStreamQueryKey();
-
-  const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStream>>> = ({
-    signal,
-  }) => getEventStream(requestOptions, signal);
-
-  return { queryKey, queryFn, ...queryOptions };
-};
-
-export type GetEventStreamQueryResult = NonNullable<
-  Awaited<ReturnType<typeof getEventStream>>
->;
-export type GetEventStreamQueryError = ErrorType<void | AsError>;
-
-export const 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 } => {
-  const queryOptions = getGetEventStreamQueryOptions(options);
-
-  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
-  };
-
-  query.queryKey = queryOptions.queryKey;
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamQueryKey();
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStream>>> = ({ signal }) => getEventStream(requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetEventStreamSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStream>>>
+export type GetEventStreamSuspenseQueryError = ErrorType<void | AsError>
+
+/**
+ * @summary Gets the details of your EventStream
+ */
+export const useGetEventStreamSuspense = <TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetEventStreamSuspenseQueryOptions(options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
 
   return query;
-};
+}
+
+
 
 /**
  * Creates a new event stream (based on the **Server Sent Events** framework) for the authenticated user.
@@ -110,151 +145,156 @@ A user is only permitted one event stream.
  * @summary Create a new Server-Sent Events EventStream
  */
 export const createEventStream = (
-  options?: SecondParameter<typeof customInstance>
+    
+ options?: SecondParameter<typeof customInstance>,) => {
+      
+      
+      return customInstance<EventStreamGetPostResponse>(
+      {url: `/event-stream`, method: 'POST'
+    },
+      options);
+    }
+  
+
+
+export const getCreateEventStreamMutationOptions = <TError = ErrorType<AsError | void>,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createEventStream>>, TError,void, TContext>, request?: SecondParameter<typeof customInstance>}
+): UseMutationOptions<Awaited<ReturnType<typeof createEventStream>>, TError,void, TContext> => {
+ const {mutation: mutationOptions, request: requestOptions} = options ?? {};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof createEventStream>>, void> = () => {
+          
+
+          return  createEventStream(requestOptions)
+        }
+
+        
+
+
+   return  { mutationFn, ...mutationOptions }}
+
+    export type CreateEventStreamMutationResult = NonNullable<Awaited<ReturnType<typeof createEventStream>>>
+    
+    export type CreateEventStreamMutationError = ErrorType<AsError | void>
+
+    /**
+ * @summary Create a new Server-Sent Events EventStream
+ */
+export const useCreateEventStream = <TError = ErrorType<AsError | void>,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createEventStream>>, TError,void, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
-  return customInstance<EventStreamGetPostResponse>(
-    { url: `/event-stream`, method: "post" },
-    options
-  );
-};
-
-export const getCreateEventStreamMutationOptions = <
-  TError = ErrorType<AsError | void>,
-  TVariables = void,
-  TContext = unknown
->(options?: {
-  mutation?: UseMutationOptions<
-    Awaited<ReturnType<typeof createEventStream>>,
-    TError,
-    TVariables,
-    TContext
-  >;
-  request?: SecondParameter<typeof customInstance>;
-}): UseMutationOptions<
-  Awaited<ReturnType<typeof createEventStream>>,
-  TError,
-  TVariables,
-  TContext
-> => {
-  const { mutation: mutationOptions, request: requestOptions } = options ?? {};
-
-  const mutationFn: MutationFunction<
-    Awaited<ReturnType<typeof createEventStream>>,
-    TVariables
-  > = () => {
-    return createEventStream(requestOptions);
-  };
-
-  return { mutationFn, ...mutationOptions };
-};
-
-export type CreateEventStreamMutationResult = NonNullable<
-  Awaited<ReturnType<typeof createEventStream>>
->;
-
-export type CreateEventStreamMutationError = ErrorType<AsError | void>;
-
-export const useCreateEventStream = <
-  TError = ErrorType<AsError | void>,
-  TVariables = void,
-  TContext = unknown
->(options?: {
-  mutation?: UseMutationOptions<
-    Awaited<ReturnType<typeof createEventStream>>,
-    TError,
-    TVariables,
-    TContext
-  >;
-  request?: SecondParameter<typeof customInstance>;
-}) => {
-  const mutationOptions = getCreateEventStreamMutationOptions(options);
-
-  return useMutation(mutationOptions);
-};
-/**
+
+      const mutationOptions = getCreateEventStreamMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
  * Gets events that you are entitled to receive. Events are delivered as **Server Sent Events** and you are expected to continuously read form this endpoint or it will be closed.
 
-This is an un-authenticated endpoint. In order to read from the stream the caller must provide the **read token** they were allocated when the stream was created The token must be provided in the request header property `X-IM-AS-EventStreamReadToken`.
+This is an un-authenticated endpoint. In order to read from the stream the caller must provide either the User access token that belongs to the event stream or the **read token** that was allocated when the stream was created. The **read token** must be provided in the request header property `X-IM-AS-EventStreamReadToken`.
 
  * @summary Subscribe to Server-Sent Events events from an EventStream
  */
 export const getEventStreamEvents = (
-  eventStreamId: number,
-  options?: SecondParameter<typeof customInstance>,
-  signal?: AbortSignal
+    eventStreamId: number,
+ options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
 ) => {
-  return customInstance<string>(
-    { url: `/event-stream/${eventStreamId}`, method: "get", signal },
-    options
-  );
-};
-
-export const getGetEventStreamEventsQueryKey = (eventStreamId: number) =>
-  ["account-server-api", `/event-stream/${eventStreamId}`] as const;
-
-export const getGetEventStreamEventsQueryOptions = <
-  TData = Awaited<ReturnType<typeof getEventStreamEvents>>,
-  TError = ErrorType<void | AsError>
->(
-  eventStreamId: number,
-  options?: {
-    query?: UseQueryOptions<
-      Awaited<ReturnType<typeof getEventStreamEvents>>,
-      TError,
-      TData
-    >;
-    request?: SecondParameter<typeof customInstance>;
-  }
-): UseQueryOptions<
-  Awaited<ReturnType<typeof getEventStreamEvents>>,
-  TError,
-  TData
-> & { queryKey: QueryKey } => {
-  const { query: queryOptions, request: requestOptions } = options ?? {};
-
-  const queryKey =
-    queryOptions?.queryKey ?? getGetEventStreamEventsQueryKey(eventStreamId);
-
-  const queryFn: QueryFunction<
-    Awaited<ReturnType<typeof getEventStreamEvents>>
-  > = ({ signal }) =>
-    getEventStreamEvents(eventStreamId, requestOptions, signal);
-
-  return { queryKey, queryFn, enabled: !!eventStreamId, ...queryOptions };
-};
-
-export type GetEventStreamEventsQueryResult = NonNullable<
-  Awaited<ReturnType<typeof getEventStreamEvents>>
->;
-export type GetEventStreamEventsQueryError = ErrorType<void | AsError>;
-
-export const useGetEventStreamEvents = <
-  TData = Awaited<ReturnType<typeof getEventStreamEvents>>,
-  TError = ErrorType<void | AsError>
->(
-  eventStreamId: number,
-  options?: {
-    query?: UseQueryOptions<
-      Awaited<ReturnType<typeof getEventStreamEvents>>,
-      TError,
-      TData
-    >;
-    request?: SecondParameter<typeof customInstance>;
-  }
-): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
-  const queryOptions = getGetEventStreamEventsQueryOptions(
-    eventStreamId,
-    options
-  );
-
-  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & {
-    queryKey: QueryKey;
-  };
-
-  query.queryKey = queryOptions.queryKey;
+      
+      
+      return customInstance<string>(
+      {url: `/event-stream/${eventStreamId}`, method: 'GET', signal
+    },
+      options);
+    }
+  
+
+export const getGetEventStreamEventsQueryKey = (eventStreamId: number,) => {
+    return ["account-server-api", `/event-stream/${eventStreamId}`] as const;
+    }
+
+    
+export const getGetEventStreamEventsQueryOptions = <TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(eventStreamId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamEventsQueryKey(eventStreamId);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStreamEvents>>> = ({ signal }) => getEventStreamEvents(eventStreamId, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(eventStreamId), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetEventStreamEventsQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStreamEvents>>>
+export type GetEventStreamEventsQueryError = ErrorType<void | AsError>
+
+/**
+ * @summary Subscribe to Server-Sent Events events from an EventStream
+ */
+export const useGetEventStreamEvents = <TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(
+ eventStreamId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetEventStreamEventsQueryOptions(eventStreamId,options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+export const getGetEventStreamEventsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(eventStreamId: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamEventsQueryKey(eventStreamId);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStreamEvents>>> = ({ signal }) => getEventStreamEvents(eventStreamId, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(eventStreamId), ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetEventStreamEventsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStreamEvents>>>
+export type GetEventStreamEventsSuspenseQueryError = ErrorType<void | AsError>
+
+/**
+ * @summary Subscribe to Server-Sent Events events from an EventStream
+ */
+export const useGetEventStreamEventsSuspense = <TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(
+ eventStreamId: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetEventStreamEventsSuspenseQueryOptions(eventStreamId,options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
 
   return query;
-};
+}
+
+
 
 /**
  * Deletes an Event Stream.
@@ -264,65 +304,50 @@ You must be the user who created the event stream.
  * @summary Deletes an existing EventStream (that you created)
  */
 export const deleteEventStream = (
-  eventStreamId: number,
-  options?: SecondParameter<typeof customInstance>
+    eventStreamId: number,
+ options?: SecondParameter<typeof customInstance>,) => {
+      
+      
+      return customInstance<void>(
+      {url: `/event-stream/${eventStreamId}`, method: 'DELETE'
+    },
+      options);
+    }
+  
+
+
+export const getDeleteEventStreamMutationOptions = <TError = ErrorType<AsError>,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteEventStream>>, TError,{eventStreamId: number}, TContext>, request?: SecondParameter<typeof customInstance>}
+): UseMutationOptions<Awaited<ReturnType<typeof deleteEventStream>>, TError,{eventStreamId: number}, TContext> => {
+ const {mutation: mutationOptions, request: requestOptions} = options ?? {};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof deleteEventStream>>, {eventStreamId: number}> = (props) => {
+          const {eventStreamId} = props ?? {};
+
+          return  deleteEventStream(eventStreamId,requestOptions)
+        }
+
+        
+
+
+   return  { mutationFn, ...mutationOptions }}
+
+    export type DeleteEventStreamMutationResult = NonNullable<Awaited<ReturnType<typeof deleteEventStream>>>
+    
+    export type DeleteEventStreamMutationError = ErrorType<AsError>
+
+    /**
+ * @summary Deletes an existing EventStream (that you created)
+ */
+export const useDeleteEventStream = <TError = ErrorType<AsError>,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteEventStream>>, TError,{eventStreamId: number}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
-  return customInstance<void>(
-    { url: `/event-stream/${eventStreamId}`, method: "delete" },
-    options
-  );
-};
-
-export const getDeleteEventStreamMutationOptions = <
-  TError = ErrorType<AsError>,
-  TContext = unknown
->(options?: {
-  mutation?: UseMutationOptions<
-    Awaited<ReturnType<typeof deleteEventStream>>,
-    TError,
-    { eventStreamId: number },
-    TContext
-  >;
-  request?: SecondParameter<typeof customInstance>;
-}): UseMutationOptions<
-  Awaited<ReturnType<typeof deleteEventStream>>,
-  TError,
-  { eventStreamId: number },
-  TContext
-> => {
-  const { mutation: mutationOptions, request: requestOptions } = options ?? {};
-
-  const mutationFn: MutationFunction<
-    Awaited<ReturnType<typeof deleteEventStream>>,
-    { eventStreamId: number }
-  > = (props) => {
-    const { eventStreamId } = props ?? {};
-
-    return deleteEventStream(eventStreamId, requestOptions);
-  };
-
-  return { mutationFn, ...mutationOptions };
-};
-
-export type DeleteEventStreamMutationResult = NonNullable<
-  Awaited<ReturnType<typeof deleteEventStream>>
->;
-
-export type DeleteEventStreamMutationError = ErrorType<AsError>;
-
-export const useDeleteEventStream = <
-  TError = ErrorType<AsError>,
-  TContext = unknown
->(options?: {
-  mutation?: UseMutationOptions<
-    Awaited<ReturnType<typeof deleteEventStream>>,
-    TError,
-    { eventStreamId: number },
-    TContext
-  >;
-  request?: SecondParameter<typeof customInstance>;
-}) => {
-  const mutationOptions = getDeleteEventStreamMutationOptions(options);
-
-  return useMutation(mutationOptions);
-};
+
+      const mutationOptions = getDeleteEventStreamMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+