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

package/src/api/actions/actions.fetch.ts

@@ -10,10 +10,14 @@ A service that provides access to the Account Server, which gives *registered* u
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
+  DataTag,
+  DefinedInitialDataOptions,
+  DefinedUseQueryResult,
   InvalidateOptions,
   QueryClient,
   QueryFunction,
   QueryKey,
+  UndefinedInitialDataOptions,
   UseQueryOptions,
   UseQueryResult,
   UseSuspenseQueryOptions,
@@ -78,7 +82,7 @@ export const getGetActionsQueryOptions = <
 >(
   params?: GetActionsParams,
   options?: {
-    query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
     request?: SecondParameter<typeof customFetch>;
   },
 ) => {
@@ -93,12 +97,61 @@ export const getGetActionsQueryOptions = <
     Awaited<ReturnType<typeof getActions>>,
     TError,
     TData
-  > & { queryKey: QueryKey };
+  > & { queryKey: DataTag<QueryKey, TData> };
 };
 
 export type GetActionsQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;
 export type GetActionsQueryError = ErrorType<void>;
 
+export function useGetActions<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params: undefined | GetActionsParams,
+  options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> &
+      Pick<
+        DefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getActions>>,
+          TError,
+          Awaited<ReturnType<typeof getActions>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetActions<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> &
+      Pick<
+        UndefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getActions>>,
+          TError,
+          Awaited<ReturnType<typeof getActions>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetActions<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
 /**
  * @summary Gets Actions held on the Account Server
  */
@@ -109,13 +162,16 @@ export function useGetActions<
 >(
   params?: GetActionsParams,
   options?: {
-    query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
     request?: SecondParameter<typeof customFetch>;
   },
-): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
   const queryOptions = getGetActionsQueryOptions(params, 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;
 
@@ -141,7 +197,7 @@ export const getGetActionsSuspenseQueryOptions = <
 >(
   params?: GetActionsParams,
   options?: {
-    query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
     request?: SecondParameter<typeof customFetch>;
   },
 ) => {
@@ -156,12 +212,45 @@ export const getGetActionsSuspenseQueryOptions = <
     Awaited<ReturnType<typeof getActions>>,
     TError,
     TData
-  > & { queryKey: QueryKey };
+  > & { queryKey: DataTag<QueryKey, TData> };
 };
 
 export type GetActionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;
 export type GetActionsSuspenseQueryError = ErrorType<void>;
 
+export function useGetActionsSuspense<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params: undefined | GetActionsParams,
+  options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetActionsSuspense<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetActionsSuspense<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customFetch>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
 /**
  * @summary Gets Actions held on the Account Server
  */
@@ -172,15 +261,17 @@ export function useGetActionsSuspense<
 >(
   params?: GetActionsParams,
   options?: {
-    query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
     request?: SecondParameter<typeof customFetch>;
   },
-): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
   const queryOptions = getGetActionsSuspenseQueryOptions(params, 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;
 

package/src/api/actions/actions.ts

@@ -10,10 +10,14 @@ A service that provides access to the Account Server, which gives *registered* u
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
+  DataTag,
+  DefinedInitialDataOptions,
+  DefinedUseQueryResult,
   InvalidateOptions,
   QueryClient,
   QueryFunction,
   QueryKey,
+  UndefinedInitialDataOptions,
   UseQueryOptions,
   UseQueryResult,
   UseSuspenseQueryOptions,
@@ -59,7 +63,7 @@ export const getGetActionsQueryOptions = <
 >(
   params?: GetActionsParams,
   options?: {
-    query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
   },
 ) => {
@@ -74,12 +78,61 @@ export const getGetActionsQueryOptions = <
     Awaited<ReturnType<typeof getActions>>,
     TError,
     TData
-  > & { queryKey: QueryKey };
+  > & { queryKey: DataTag<QueryKey, TData> };
 };
 
 export type GetActionsQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;
 export type GetActionsQueryError = ErrorType<void>;
 
+export function useGetActions<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params: undefined | GetActionsParams,
+  options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> &
+      Pick<
+        DefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getActions>>,
+          TError,
+          Awaited<ReturnType<typeof getActions>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetActions<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> &
+      Pick<
+        UndefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getActions>>,
+          TError,
+          Awaited<ReturnType<typeof getActions>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetActions<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
 /**
  * @summary Gets Actions held on the Account Server
  */
@@ -90,13 +143,16 @@ export function useGetActions<
 >(
   params?: GetActionsParams,
   options?: {
-    query?: UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
   },
-): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
   const queryOptions = getGetActionsQueryOptions(params, 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;
 
@@ -122,7 +178,7 @@ export const getGetActionsSuspenseQueryOptions = <
 >(
   params?: GetActionsParams,
   options?: {
-    query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
   },
 ) => {
@@ -137,12 +193,45 @@ export const getGetActionsSuspenseQueryOptions = <
     Awaited<ReturnType<typeof getActions>>,
     TError,
     TData
-  > & { queryKey: QueryKey };
+  > & { queryKey: DataTag<QueryKey, TData> };
 };
 
 export type GetActionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;
 export type GetActionsSuspenseQueryError = ErrorType<void>;
 
+export function useGetActionsSuspense<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params: undefined | GetActionsParams,
+  options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetActionsSuspense<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+export function useGetActionsSuspense<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
 /**
  * @summary Gets Actions held on the Account Server
  */
@@ -153,15 +242,17 @@ export function useGetActionsSuspense<
 >(
   params?: GetActionsParams,
   options?: {
-    query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>;
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
   },
-): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
   const queryOptions = getGetActionsSuspenseQueryOptions(params, 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;