@navios/react-query 0.1.0

package/src/types/client-instance.mts

@@ -0,0 +1,502 @@
+import type {
+  BaseEndpointConfig,
+  UrlHasParams,
+  UrlParams,
+  Util_FlatObject,
+} from '@navios/common'
+import type {
+  DataTag,
+  InfiniteData,
+  QueryClient,
+  UseMutationResult,
+  UseSuspenseInfiniteQueryOptions,
+  UseSuspenseQueryOptions,
+} from '@tanstack/react-query'
+import type { AnyZodObject, z, ZodType } from 'zod'
+
+import type { ProcessResponseFunction, Split } from '../types.mjs'
+import type { ClientMutationArgs } from './mutation-args.mjs'
+import type { MutationHelpers } from './mutation-helpers.mjs'
+import type { ClientQueryArgs } from './query-args.mjs'
+import type { QueryHelpers } from './query-helpers.mjs'
+
+export interface ClientInstance {
+  query<
+    Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET',
+    Url extends string = string,
+    Response extends ZodType = ZodType,
+    Result = z.output<Response>,
+  >(config: {
+    method: Method
+    url: Url
+    responseSchema: Response
+    processResponse?: (data: z.output<Response>) => Result
+  }): ((
+    params: Util_FlatObject<ClientQueryArgs<Url, undefined>>,
+  ) => UseSuspenseQueryOptions<
+    Result,
+    Error,
+    Result,
+    DataTag<Split<Url, '/'>, Result, Error>
+  >) &
+    QueryHelpers<Url, undefined, Result>
+
+  query<
+    Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET',
+    Url extends string = string,
+    QuerySchema extends AnyZodObject = AnyZodObject,
+    Response extends ZodType = ZodType,
+    Result = z.output<Response>,
+  >(config: {
+    method: Method
+    url: Url
+    querySchema: QuerySchema
+    responseSchema: Response
+    processResponse?: (data: z.output<Response>) => Result
+  }): ((
+    params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>,
+  ) => UseSuspenseQueryOptions<
+    Result,
+    Error,
+    Result,
+    DataTag<Split<Url, '/'>, Result, Error>
+  >) &
+    QueryHelpers<Url, QuerySchema, Result>
+
+  infiniteQuery<
+    Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET',
+    Url extends string = string,
+    QuerySchema extends AnyZodObject = AnyZodObject,
+    Response extends ZodType = ZodType,
+    PageResult = z.output<Response>,
+    Result = InfiniteData<PageResult>,
+  >(config: {
+    method: Method
+    url: Url
+    querySchema: QuerySchema
+    responseSchema: Response
+    processResponse?: (data: z.output<Response>) => PageResult
+    getNextPageParam: (
+      lastPage: PageResult,
+      allPages: PageResult[],
+      lastPageParam: z.infer<QuerySchema> | undefined,
+      allPageParams: z.infer<QuerySchema>[] | undefined,
+    ) => z.input<QuerySchema> | undefined
+    getPreviousPageParam?: (
+      firstPage: PageResult,
+      allPages: PageResult[],
+      lastPageParam: z.infer<QuerySchema> | undefined,
+      allPageParams: z.infer<QuerySchema>[] | undefined,
+    ) => z.input<QuerySchema>
+  }): ((
+    params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>,
+  ) => UseSuspenseInfiniteQueryOptions<
+    PageResult,
+    Error,
+    Result,
+    PageResult,
+    DataTag<Split<Url, '/'>, PageResult, Error>,
+    z.output<QuerySchema>
+  >) &
+    QueryHelpers<Url, QuerySchema, PageResult, true>
+
+  mutation<
+    Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH',
+    Url extends string = string,
+    RequestSchema extends ZodType = ZodType,
+    QuerySchema extends AnyZodObject = AnyZodObject,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+    UseKey extends true = true,
+  >(config: {
+    method: Method
+    url: Url
+    useKey: UseKey
+    requestSchema: RequestSchema
+    querySchema: QuerySchema
+    responseSchema: Response
+    processResponse: ProcessResponseFunction<Result, ReqResult>
+    useContext?: () => Context
+    onSuccess?: (
+      queryClient: QueryClient,
+      data: NoInfer<Result>,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, RequestSchema, QuerySchema>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+    onError?: (
+      queryClient: QueryClient,
+      error: Error,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, RequestSchema, QuerySchema>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+  }): ((
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, RequestSchema, QuerySchema>
+  >) &
+    MutationHelpers<Url, Result>
+
+  mutation<
+    Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH',
+    Url extends string = string,
+    RequestSchema extends ZodType = ZodType,
+    QuerySchema extends AnyZodObject = AnyZodObject,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+  >(config: {
+    method: Method
+    url: Url
+    requestSchema: RequestSchema
+    querySchema: QuerySchema
+    responseSchema: Response
+    processResponse: ProcessResponseFunction<Result, ReqResult>
+    useContext?: () => Context
+    onSuccess?: (
+      queryClient: QueryClient,
+      data: NoInfer<Result>,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, RequestSchema, QuerySchema>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+    onError?: (
+      queryClient: QueryClient,
+      error: Error,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, RequestSchema, QuerySchema>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+  }): (
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, RequestSchema, QuerySchema>
+  >
+
+  mutation<
+    Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH',
+    Url extends string = string,
+    RequestSchema extends ZodType = ZodType,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+  >(config: {
+    method: Method
+    url: Url
+    requestSchema: RequestSchema
+    responseSchema: Response
+    processResponse: ProcessResponseFunction<Result, ReqResult>
+    useContext?: () => Context
+    onSuccess?: (
+      queryClient: QueryClient,
+      data: NoInfer<Result>,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, RequestSchema, undefined>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+    onError?: (
+      queryClient: QueryClient,
+      error: Error,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, RequestSchema, undefined>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+  }): ((
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, RequestSchema, undefined>
+  >) &
+    MutationHelpers<Url, Result>
+
+  mutation<
+    Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH',
+    Url extends string = string,
+    RequestSchema extends ZodType = ZodType,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+    UseKey extends true = true,
+  >(config: {
+    method: Method
+    url: Url
+    useKey: UseKey
+    requestSchema: RequestSchema
+    responseSchema: Response
+    processResponse: ProcessResponseFunction<Result, ReqResult>
+    useContext?: () => Context
+    onSuccess?: (
+      queryClient: QueryClient,
+      data: NoInfer<Result>,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, RequestSchema, undefined>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+    onError?: (
+      queryClient: QueryClient,
+      error: Error,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, RequestSchema, undefined>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+  }): ((
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, RequestSchema, undefined>
+  >) &
+    MutationHelpers<Url, Result>
+
+  mutation<
+    Method extends 'DELETE' = 'DELETE',
+    Url extends string = string,
+    QuerySchema extends AnyZodObject = AnyZodObject,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+    UseKey extends true = true,
+  >(config: {
+    method: Method
+    url: Url
+    useKey: UseKey
+    querySchema: QuerySchema
+    responseSchema: Response
+    processResponse: ProcessResponseFunction<Result, ReqResult>
+    useContext?: () => Context
+    onSuccess?: (
+      queryClient: QueryClient,
+      data: NoInfer<Result>,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, undefined, QuerySchema>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+    onError?: (
+      queryClient: QueryClient,
+      error: Error,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, undefined, QuerySchema>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+  }): ((
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, undefined, QuerySchema>
+  >) &
+    MutationHelpers<Url, Result>
+
+  mutation<
+    Method extends 'DELETE' = 'DELETE',
+    Url extends string = string,
+    QuerySchema extends AnyZodObject = AnyZodObject,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+  >(config: {
+    method: Method
+    url: Url
+    querySchema: QuerySchema
+    responseSchema: Response
+    processResponse: ProcessResponseFunction<Result, ReqResult>
+    useContext?: () => Context
+    onSuccess?: (
+      queryClient: QueryClient,
+      data: NoInfer<Result>,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, undefined, QuerySchema>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+    onError?: (
+      queryClient: QueryClient,
+      error: Error,
+      variables: Util_FlatObject<
+        ClientMutationArgs<Url, undefined, QuerySchema>
+      >,
+      context: Context,
+    ) => void | Promise<void>
+  }): (
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, undefined, QuerySchema>
+  >
+
+  mutation<
+    Method extends 'DELETE' = 'DELETE',
+    Url extends string = string,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+    UseKey extends true = true,
+  >(config: {
+    method: Method
+    url: Url
+    useKey: UseKey
+    responseSchema: Response
+    processResponse: ProcessResponseFunction<Result, ReqResult>
+    useContext?: () => Context
+    onSuccess?: (
+      queryClient: QueryClient,
+      data: NoInfer<Result>,
+      variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>,
+      context: Context,
+    ) => void | Promise<void>
+    onError?: (
+      queryClient: QueryClient,
+      error: Error,
+      variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>,
+      context: Context,
+    ) => void | Promise<void>
+  }): ((
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, undefined, undefined>
+  >) &
+    MutationHelpers<Url, Result>
+
+  mutation<
+    Method extends 'DELETE' = 'DELETE',
+    Url extends string = string,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+  >(config: {
+    method: Method
+    url: Url
+    responseSchema: Response
+    processResponse: ProcessResponseFunction<Result, ReqResult>
+    useContext?: () => Context
+    onSuccess?: (
+      queryClient: QueryClient,
+      data: NoInfer<Result>,
+      variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>,
+      context: Context,
+    ) => void | Promise<void>
+    onError?: (
+      queryClient: QueryClient,
+      error: Error,
+      variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>,
+      context: Context,
+    ) => void | Promise<void>
+  }): (
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, undefined, undefined>
+  >
+
+  queryFromEndpoint<
+    Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET',
+    Url extends string = string,
+    QuerySchema extends AnyZodObject = AnyZodObject,
+    Response extends ZodType = ZodType,
+    Result = z.output<Response>,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<Method, Url, QuerySchema, Response>
+    },
+    options?: {
+      processResponse?: (data: z.output<Response>) => Result
+    },
+  ): (
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseSuspenseQueryOptions<
+    Result,
+    Error,
+    Result,
+    DataTag<Split<Url, '/'>, Result, Error>
+  > &
+    QueryHelpers<Url, QuerySchema, Result>
+
+  queryFromEndpoint<
+    Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET',
+    Url extends string = string,
+    Response extends ZodType = ZodType,
+    Result = z.output<Response>,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<Method, Url, undefined, Response>
+    },
+    options?: {
+      processResponse?: (data: z.output<Response>) => Result
+    },
+  ): (
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseSuspenseQueryOptions<
+    Result,
+    Error,
+    Result,
+    DataTag<Split<Url, '/'>, Result, Error>
+  > &
+    QueryHelpers<Url, undefined, Result>
+
+  infiniteQueryFromEndpoint<
+    Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET',
+    Url extends string = string,
+    QuerySchema extends AnyZodObject = AnyZodObject,
+    Response extends ZodType = ZodType,
+    PageResult = z.output<Response>,
+    Result = InfiniteData<PageResult>,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<Method, Url, QuerySchema, Response>
+    },
+    options: {
+      processResponse?: (data: z.output<Response>) => PageResult
+      getNextPageParam: (
+        lastPage: PageResult,
+        allPages: PageResult[],
+        lastPageParam: z.infer<QuerySchema> | undefined,
+        allPageParams: z.infer<QuerySchema>[] | undefined,
+      ) => z.input<QuerySchema> | undefined
+      getPreviousPageParam?: (
+        firstPage: PageResult,
+        allPages: PageResult[],
+        lastPageParam: z.infer<QuerySchema> | undefined,
+        allPageParams: z.infer<QuerySchema>[] | undefined,
+      ) => z.input<QuerySchema>
+    },
+  ): (
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseSuspenseInfiniteQueryOptions<
+    PageResult,
+    Error,
+    Result,
+    PageResult,
+    DataTag<Split<Url, '/'>, PageResult, Error>,
+    z.output<QuerySchema>
+  > &
+    QueryHelpers<Url, QuerySchema, PageResult, true>
+}

package/src/types/index.mts

@@ -0,0 +1,6 @@
+export * from './client-instance.mjs'
+export * from './mutation-args.mjs'
+export * from './mutation-helpers.mjs'
+export * from './query-args.mjs'
+export * from './query-helpers.mjs'
+export * from './query-url-params-args.mjs'

package/src/types/mutation-args.mts

@@ -0,0 +1,10 @@
+import type { UrlHasParams, UrlParams } from '@navios/common'
+import type { AnyZodObject, z } from 'zod'
+
+export type ClientMutationArgs<
+  Url extends string = string,
+  RequestSchema = unknown,
+  QuerySchema = unknown,
+> = (UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {}) &
+  (RequestSchema extends AnyZodObject ? { data: z.input<RequestSchema> } : {}) &
+  (QuerySchema extends AnyZodObject ? { params: z.input<QuerySchema> } : {})

package/src/types/mutation-helpers.mts

@@ -0,0 +1,13 @@
+import type { UrlHasParams, UrlParams } from '@navios/common'
+import type { DataTag } from '@tanstack/react-query'
+
+export type MutationHelpers<Url extends string, Result = unknown> =
+  UrlHasParams<Url> extends true
+    ? {
+        mutationKey: (params: UrlParams<Url>) => DataTag<[Url], Result, Error>
+        useIsMutating: (keyParams: UrlParams<Url>) => boolean
+      }
+    : {
+        mutationKey: () => DataTag<[Url], Result, Error>
+        useIsMutating: () => boolean
+      }

package/src/types/query-args.mts

@@ -0,0 +1,8 @@
+import type { UrlHasParams, UrlParams } from '@navios/common'
+import type { AnyZodObject, z } from 'zod'
+
+export type ClientQueryArgs<
+  Url extends string = string,
+  QuerySchema = AnyZodObject,
+> = (UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {}) &
+  (QuerySchema extends AnyZodObject ? { params: z.input<QuerySchema> } : {})

package/src/types/query-helpers.mts

@@ -0,0 +1,34 @@
+import type { Util_FlatObject } from '@navios/common'
+import type {
+  QueryClient,
+  UseQueryResult,
+  UseSuspenseQueryResult,
+} from '@tanstack/react-query'
+import type { AnyZodObject } from 'zod'
+
+import type { QueryKeyCreatorResult } from '../utils/query-key-creator.mjs'
+import type { ClientQueryArgs } from './query-args.mjs'
+import type { ClientQueryUrlParamsArgs } from './query-url-params-args.mjs'
+
+export type QueryHelpers<
+  Url extends string,
+  QuerySchema extends AnyZodObject | undefined = undefined,
+  Result = undefined,
+  IsInfinite extends boolean = false,
+> = {
+  queryKey: QueryKeyCreatorResult<QuerySchema, Url, Result, IsInfinite>
+  use: (
+    params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>,
+  ) => UseQueryResult<Result, Error>
+  useSuspense: (
+    params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>,
+  ) => UseSuspenseQueryResult<Result, Error>
+  invalidate: (
+    queryClient: QueryClient,
+    params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>,
+  ) => () => Promise<void>
+  invalidateAll: (
+    queryClient: QueryClient,
+    params: Util_FlatObject<ClientQueryUrlParamsArgs<Url>>,
+  ) => () => Promise<void>
+}

package/src/types/query-url-params-args.mts

@@ -0,0 +1,6 @@
+import type { UrlHasParams, UrlParams } from '@navios/common'
+
+export type ClientQueryUrlParamsArgs<Url extends string = string> =
+  UrlHasParams<Url> extends true
+    ? { urlParams: UrlParams<Url> }
+    : {} | undefined

package/src/types.mts

@@ -0,0 +1,118 @@
+import type {
+  AnyEndpointConfig,
+  BaseEndpointConfig,
+  BuilderInstance,
+  HttpMethod,
+  NaviosZodRequest,
+  UrlHasParams,
+  UrlParams,
+} from '@navios/common'
+import type { QueryClient, UseMutationOptions } from '@tanstack/react-query'
+import type { AnyZodObject, z } from 'zod'
+
+export type Split<S extends string, D extends string> = string extends S
+  ? string[]
+  : S extends ''
+    ? []
+    : S extends `${infer T}${D}${infer U}`
+      ? [T, ...Split<U, D>]
+      : [S]
+
+export type ProcessResponseFunction<TData = unknown, TVariables = unknown> = (
+  variables: TVariables,
+) => Promise<TData> | TData
+
+export type ClientOptions<ProcessResponse = unknown> = {
+  api: BuilderInstance
+  defaults?: {
+    keyPrefix?: string[]
+    keySuffix?: string[]
+  }
+}
+
+export type BaseQueryParams<Config extends AnyEndpointConfig, Res = any> = {
+  keyPrefix?: string[]
+  keySuffix?: string[]
+  onFail?: (err: unknown) => void
+  processResponse: (data: z.output<Config['responseSchema']>) => Res
+}
+
+export interface BaseMutationParams<
+  Config extends AnyEndpointConfig,
+  TData = unknown,
+  TVariables = BaseMutationArgs<Config>,
+  TResponse = z.output<Config['responseSchema']>,
+  TContext = unknown,
+  UseKey extends boolean = false,
+> extends Omit<
+    UseMutationOptions<TData, Error, TVariables>,
+    'mutationKey' | 'mutationFn' | 'onSuccess' | 'onError' | 'scope'
+  > {
+  processResponse: ProcessResponseFunction<TData, TResponse>
+  /**
+   * React hooks that will prepare the context for the mutation onSuccess and onError
+   * callbacks. This is useful for when you want to use the context in the callbacks
+   */
+  useContext?: () => TContext
+  onSuccess?: (
+    queryClient: QueryClient,
+    data: TData,
+    variables: TVariables,
+    context: TContext,
+  ) => void | Promise<void>
+  onError?: (
+    queryClient: QueryClient,
+    err: unknown,
+    variables: TVariables,
+    context: TContext,
+  ) => void | Promise<void>
+
+  /**
+   * If true, we will create a mutation key that can be shared across the project.
+   */
+  useKey?: UseKey
+  keyPrefix?: UseKey extends true
+    ? UrlHasParams<Config['url']> extends true
+      ? string[]
+      : never
+    : never
+  keySuffix?: UseKey extends true
+    ? UrlHasParams<Config['url']> extends true
+      ? string[]
+      : never
+    : never
+}
+
+export type BaseQueryArgs<Config extends AnyEndpointConfig> = (UrlHasParams<
+  Config['url']
+> extends true
+  ? { urlParams: UrlParams<Config['url']> }
+  : {}) &
+  (Config['querySchema'] extends AnyZodObject
+    ? { params: z.input<Config['querySchema']> }
+    : {})
+
+export type BaseMutationArgs<Config extends AnyEndpointConfig> =
+  NaviosZodRequest<Config>
+
+export type InfiniteQueryOptions<
+  Config extends BaseEndpointConfig<HttpMethod, string, AnyZodObject>,
+  Res = any,
+> = {
+  keyPrefix?: string[]
+  keySuffix?: string[]
+  processResponse: (data: z.infer<Config['responseSchema']>) => Res
+  onFail?: (err: unknown) => void
+  getNextPageParam: (
+    lastPage: z.infer<Config['responseSchema']>,
+    allPages: z.infer<Config['responseSchema']>[],
+    lastPageParam: z.infer<Config['querySchema']> | undefined,
+    allPageParams: z.infer<Config['querySchema']>[] | undefined,
+  ) =>
+    | z.input<Config['querySchema']>
+    | z.infer<Config['querySchema']>
+    | undefined
+  initialPageParam?:
+    | z.input<Config['querySchema']>
+    | z.infer<Config['querySchema']>
+}