@squonk/account-server-client 2.0.9 → 2.1.0-beta.1

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

@@ -0,0 +1,353 @@
+/**
+ * Generated by orval v6.25.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: 2.1
+ */
+import {
+  useMutation,
+  useQuery,
+  useSuspenseQuery
+} from '@tanstack/react-query'
+import type {
+  MutationFunction,
+  QueryFunction,
+  QueryKey,
+  UseMutationOptions,
+  UseQueryOptions,
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult
+} from '@tanstack/react-query'
+import type {
+  AsError,
+  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.
+
+ * @summary Gets the details of your EventStream
+ */
+export const getEventStream = (
+    
+ 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>}
+) => {
+
+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.
+
+A user is only permitted one event stream.
+
+ * @summary Create a new Server-Sent Events EventStream
+ */
+export const createEventStream = (
+    
+ 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>}
+) => {
+
+      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 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
+) => {
+      
+      
+      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.
+
+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>,) => {
+      
+      
+      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>}
+) => {
+
+      const mutationOptions = getDeleteEventStreamMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    

package/src/merchant/merchant.ts

@@ -1,21 +1,24 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v6.25.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: 2.0
+ * OpenAPI spec version: 2.1
  */
 import {
-  useQuery
+  useQuery,
+  useSuspenseQuery
 } from '@tanstack/react-query'
 import type {
   QueryFunction,
   QueryKey,
   UseQueryOptions,
-  UseQueryResult
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult
 } from '@tanstack/react-query'
 import type {
   AsError,
@@ -26,13 +29,7 @@ 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;
+type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
 
 
 /**
@@ -49,19 +46,18 @@ export const getMerchants = (
       
       
       return customInstance<MerchantsGetResponse>(
-      {url: `/merchant`, method: 'get', signal
+      {url: `/merchant`, method: 'GET', signal
     },
       options);
     }
   
 
 export const getGetMerchantsQueryKey = () => {
-    
     return ["account-server-api", `/merchant`] as const;
     }
 
     
-export const getGetMerchantsQueryOptions = <TData = Awaited<ReturnType<typeof getMerchants>>, TError = ErrorType<AsError | void>>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getMerchants>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetMerchantsQueryOptions = <TData = Awaited<ReturnType<typeof getMerchants>>, TError = ErrorType<AsError | void>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getMerchants>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -86,7 +82,7 @@ export type GetMerchantsQueryError = ErrorType<AsError | void>
  * @summary Gets all Merchants
  */
 export const useGetMerchants = <TData = Awaited<ReturnType<typeof getMerchants>>, TError = ErrorType<AsError | void>>(
-  options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getMerchants>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getMerchants>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -101,6 +97,46 @@ export const useGetMerchants = <TData = Awaited<ReturnType<typeof getMerchants>>
 
 
 
+export const getGetMerchantsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getMerchants>>, TError = ErrorType<AsError | void>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getMerchants>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetMerchantsQueryKey();
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getMerchants>>> = ({ signal }) => getMerchants(requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getMerchants>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetMerchantsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getMerchants>>>
+export type GetMerchantsSuspenseQueryError = ErrorType<AsError | void>
+
+/**
+ * @summary Gets all Merchants
+ */
+export const useGetMerchantsSuspense = <TData = Awaited<ReturnType<typeof getMerchants>>, TError = ErrorType<AsError | void>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getMerchants>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetMerchantsSuspenseQueryOptions(options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
 /**
  * Gets a known Merchant
 
@@ -113,19 +149,18 @@ export const getService = (
       
       
       return customInstance<MerchantDetail>(
-      {url: `/merchant/${mId}`, method: 'get', signal
+      {url: `/merchant/${mId}`, method: 'GET', signal
     },
       options);
     }
   
 
 export const getGetServiceQueryKey = (mId: number,) => {
-    
     return ["account-server-api", `/merchant/${mId}`] as const;
     }
 
     
-export const getGetServiceQueryOptions = <TData = Awaited<ReturnType<typeof getService>>, TError = ErrorType<AsError | void>>(mId: number, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getService>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetServiceQueryOptions = <TData = Awaited<ReturnType<typeof getService>>, TError = ErrorType<AsError | void>>(mId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getService>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -150,7 +185,7 @@ export type GetServiceQueryError = ErrorType<AsError | void>
  * @summary Gets a specific Merchant
  */
 export const useGetService = <TData = Awaited<ReturnType<typeof getService>>, TError = ErrorType<AsError | void>>(
- mId: number, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getService>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+ mId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getService>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -165,3 +200,43 @@ export const useGetService = <TData = Awaited<ReturnType<typeof getService>>, TE
 
 
 
+export const getGetServiceSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getService>>, TError = ErrorType<AsError | void>>(mId: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getService>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetServiceQueryKey(mId);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getService>>> = ({ signal }) => getService(mId, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(mId), ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getService>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetServiceSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getService>>>
+export type GetServiceSuspenseQueryError = ErrorType<AsError | void>
+
+/**
+ * @summary Gets a specific Merchant
+ */
+export const useGetServiceSuspense = <TData = Awaited<ReturnType<typeof getService>>, TError = ErrorType<AsError | void>>(
+ mId: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getService>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetServiceSuspenseQueryOptions(mId,options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+