@navios/react-query 0.5.0 → 0.5.2

package/src/client/declare-client.mts

@@ -1,6 +1,8 @@
 import type {
   AbstractEndpoint,
+  AbstractStream,
   AnyEndpointConfig,
+  AnyStreamConfig,
   HttpMethod,
 } from '@navios/builder'
 import type { InfiniteData, QueryClient } from '@tanstack/react-query'
@@ -244,9 +246,11 @@ export function declareClient<Options extends ClientOptions>({
   }
 
   function mutationFromEndpoint(
-    endpoint: AbstractEndpoint<AnyEndpointConfig>,
-    options: {
-      processResponse: ProcessResponseFunction
+    endpoint:
+      | AbstractEndpoint<AnyEndpointConfig>
+      | AbstractStream<AnyStreamConfig>,
+    options?: {
+      processResponse?: ProcessResponseFunction
       useContext?: () => unknown
       onSuccess?: (
         queryClient: QueryClient,
@@ -262,12 +266,12 @@ export function declareClient<Options extends ClientOptions>({
       ) => void | Promise<void>
     },
   ) {
+    // @ts-expect-error endpoint types are compatible at runtime
     return makeMutation(endpoint, {
-      processResponse: options.processResponse,
-      useContext: options.useContext,
-      onSuccess: options.onSuccess,
-      // @ts-expect-error simplify types here
-      onError: options.onError,
+      processResponse: options?.processResponse,
+      useContext: options?.useContext,
+      onSuccess: options?.onSuccess,
+      onError: options?.onError,
       ...defaults,
     })
   }

package/src/client/types.mts

@@ -1,5 +1,6 @@
 import type {
   BaseEndpointConfig,
+  BaseStreamConfig,
   EndpointFunctionArgs,
   HttpMethod,
   UrlHasParams,
@@ -55,6 +56,24 @@ export type ClientEndpointHelper<
   QuerySchema = unknown,
 > = EndpointHelper<Method, Url, RequestSchema, ResponseSchema, QuerySchema>
 
+/**
+ * Helper type that attaches a stream endpoint to mutation results.
+ */
+export type StreamHelper<
+  Method extends HttpMethod = HttpMethod,
+  Url extends string = string,
+  RequestSchema = unknown,
+  QuerySchema = unknown,
+> = {
+  endpoint: ((
+    params: Util_FlatObject<
+      EndpointFunctionArgs<Url, QuerySchema, RequestSchema>
+    >,
+  ) => Promise<Blob>) & {
+    config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>
+  }
+}
+
 /**
  * The main client instance interface.
  * Provides methods for creating queries, infinite queries, and mutations.
@@ -393,7 +412,7 @@ export interface ClientInstance {
       context: Context,
     ) => void | Promise<void>
   }): ((
-    params: UrlHasParams<Url> extends true ? UrlParams<Url> : {},
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
   ) => UseMutationResult<
     Result,
     Error,
@@ -437,7 +456,7 @@ export interface ClientInstance {
       context: Context,
     ) => void | Promise<void>
   }): ((
-    params: UrlHasParams<Url> extends true ? UrlParams<Url> : {},
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
   ) => UseMutationResult<
     Result,
     Error,
@@ -511,7 +530,7 @@ export interface ClientInstance {
       context: Context,
     ) => void | Promise<void>
   }): ((
-    params: UrlHasParams<Url> extends true ? UrlParams<Url> : {},
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
   ) => UseMutationResult<
     Result,
     Error,
@@ -686,7 +705,7 @@ export interface ClientInstance {
       ) => void | Promise<void>
     },
   ): ((
-    params: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>,
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
   ) => UseMutationResult<
     Result,
     Error,
@@ -732,7 +751,7 @@ export interface ClientInstance {
       ) => void | Promise<void>
     },
   ): ((
-    params: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>,
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
   ) => UseMutationResult<
     Result,
     Error,
@@ -780,9 +799,7 @@ export interface ClientInstance {
         context: Context,
       ) => void | Promise<void>
     },
-  ): ((
-    params: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>,
-  ) => UseMutationResult<
+  ): (() => UseMutationResult<
     Result,
     Error,
     MutationArgs<Url, RequestSchema, QuerySchema>
@@ -823,9 +840,7 @@ export interface ClientInstance {
         context: Context,
       ) => void | Promise<void>
     },
-  ): ((
-    params: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>,
-  ) => UseMutationResult<
+  ): (() => UseMutationResult<
     Result,
     Error,
     MutationArgs<Url, RequestSchema, undefined>
@@ -866,9 +881,7 @@ export interface ClientInstance {
         context: Context,
       ) => void | Promise<void>
     },
-  ): ((
-    params: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>,
-  ) => UseMutationResult<
+  ): (() => UseMutationResult<
     Result,
     Error,
     MutationArgs<Url, undefined, QuerySchema>
@@ -906,7 +919,7 @@ export interface ClientInstance {
       ) => void | Promise<void>
     },
   ): ((
-    params: Util_FlatObject<MutationArgs<Url, undefined, undefined>>,
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
   ) => UseMutationResult<
     Result,
     Error,
@@ -943,9 +956,7 @@ export interface ClientInstance {
         context: Context,
       ) => void | Promise<void>
     },
-  ): ((
-    params: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>,
-  ) => UseMutationResult<
+  ): (() => UseMutationResult<
     Result,
     Error,
     MutationArgs<Url, undefined, QuerySchema>
@@ -979,9 +990,7 @@ export interface ClientInstance {
         context: Context,
       ) => void | Promise<void>
     },
-  ): ((
-    params: Util_FlatObject<MutationArgs<Url, undefined, undefined>>,
-  ) => UseMutationResult<
+  ): (() => UseMutationResult<
     Result,
     Error,
     MutationArgs<Url, undefined, undefined>
@@ -1135,7 +1144,7 @@ export interface ClientInstance {
       context: Context,
     ) => void | Promise<void>
   }): ((
-    params: UrlHasParams<Url> extends true ? UrlParams<Url> : {},
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
   ) => UseMutationResult<
     Result,
     Error,
@@ -1143,4 +1152,308 @@ export interface ClientInstance {
   >) &
     MutationHelpers<Url, Result> &
     EndpointHelper<Method, Url, RequestSchema, Response>
+
+  // ============================================================================
+  // STREAM MUTATION FROM ENDPOINT METHODS
+  // ============================================================================
+
+  // Stream mutation with useKey, requestSchema, and querySchema
+  mutationFromEndpoint<
+    Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH',
+    Url extends string = string,
+    RequestSchema extends ZodType = ZodType,
+    QuerySchema extends ZodObject = ZodObject,
+    Result = Blob,
+    Context = unknown,
+    UseKey extends true = true,
+  >(
+    endpoint: {
+      config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>
+    },
+    mutationOptions: {
+      processResponse?: ProcessResponseFunction<Result, Blob>
+      useKey: UseKey
+      useContext?: () => Context
+      onSuccess?: (
+        queryClient: QueryClient,
+        data: NoInfer<Result>,
+        variables: Util_FlatObject<
+          MutationArgs<Url, RequestSchema, QuerySchema>
+        >,
+        context: Context,
+      ) => void | Promise<void>
+      onError?: (
+        queryClient: QueryClient,
+        error: Error,
+        variables: Util_FlatObject<
+          MutationArgs<Url, RequestSchema, QuerySchema>
+        >,
+        context: Context,
+      ) => void | Promise<void>
+    },
+  ): ((
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    MutationArgs<Url, RequestSchema, QuerySchema>
+  >) &
+    MutationHelpers<Url, Result> &
+    StreamHelper<Method, Url, RequestSchema, QuerySchema>
+
+  // Stream mutation without useKey, with requestSchema and querySchema
+  mutationFromEndpoint<
+    Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH',
+    Url extends string = string,
+    RequestSchema extends ZodType = ZodType,
+    QuerySchema extends ZodObject = ZodObject,
+    Result = Blob,
+    Context = unknown,
+  >(
+    endpoint: {
+      config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>
+    },
+    mutationOptions?: {
+      processResponse?: ProcessResponseFunction<Result, Blob>
+      useContext?: () => Context
+      onSuccess?: (
+        queryClient: QueryClient,
+        data: NoInfer<Result>,
+        variables: Util_FlatObject<
+          MutationArgs<Url, RequestSchema, QuerySchema>
+        >,
+        context: Context,
+      ) => void | Promise<void>
+      onError?: (
+        queryClient: QueryClient,
+        error: Error,
+        variables: Util_FlatObject<
+          MutationArgs<Url, RequestSchema, QuerySchema>
+        >,
+        context: Context,
+      ) => void | Promise<void>
+    },
+  ): (() => UseMutationResult<
+    Result,
+    Error,
+    MutationArgs<Url, RequestSchema, QuerySchema>
+  >) &
+    StreamHelper<Method, Url, RequestSchema, QuerySchema>
+
+  // Stream mutation with useKey, requestSchema only
+  mutationFromEndpoint<
+    Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH',
+    Url extends string = string,
+    RequestSchema extends ZodType = ZodType,
+    Result = Blob,
+    Context = unknown,
+    UseKey extends true = true,
+  >(
+    endpoint: {
+      config: BaseStreamConfig<Method, Url, undefined, RequestSchema>
+    },
+    mutationOptions: {
+      processResponse?: ProcessResponseFunction<Result, Blob>
+      useKey: UseKey
+      useContext?: () => Context
+      onSuccess?: (
+        queryClient: QueryClient,
+        data: NoInfer<Result>,
+        variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>,
+        context: Context,
+      ) => void | Promise<void>
+      onError?: (
+        queryClient: QueryClient,
+        error: Error,
+        variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>,
+        context: Context,
+      ) => void | Promise<void>
+    },
+  ): ((
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    MutationArgs<Url, RequestSchema, undefined>
+  >) &
+    MutationHelpers<Url, Result> &
+    StreamHelper<Method, Url, RequestSchema, undefined>
+
+  // Stream mutation without useKey, with requestSchema only
+  mutationFromEndpoint<
+    Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH',
+    Url extends string = string,
+    RequestSchema extends ZodType = ZodType,
+    Result = Blob,
+    Context = unknown,
+  >(
+    endpoint: {
+      config: BaseStreamConfig<Method, Url, undefined, RequestSchema>
+    },
+    mutationOptions?: {
+      processResponse?: ProcessResponseFunction<Result, Blob>
+      useContext?: () => Context
+      onSuccess?: (
+        queryClient: QueryClient,
+        data: NoInfer<Result>,
+        variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>,
+        context: Context,
+      ) => void | Promise<void>
+      onError?: (
+        queryClient: QueryClient,
+        error: Error,
+        variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>,
+        context: Context,
+      ) => void | Promise<void>
+    },
+  ): (() => UseMutationResult<
+    Result,
+    Error,
+    MutationArgs<Url, RequestSchema, undefined>
+  >) &
+    StreamHelper<Method, Url, RequestSchema, undefined>
+
+  // Stream mutation GET methods with useKey and querySchema
+  mutationFromEndpoint<
+    Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET',
+    Url extends string = string,
+    QuerySchema extends ZodObject = ZodObject,
+    Result = Blob,
+    Context = unknown,
+    UseKey extends true = true,
+  >(
+    endpoint: {
+      config: BaseStreamConfig<Method, Url, QuerySchema, undefined>
+    },
+    mutationOptions: {
+      processResponse?: ProcessResponseFunction<Result, Blob>
+      useKey: UseKey
+      useContext?: () => Context
+      onSuccess?: (
+        queryClient: QueryClient,
+        data: NoInfer<Result>,
+        variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>,
+        context: Context,
+      ) => void | Promise<void>
+      onError?: (
+        queryClient: QueryClient,
+        error: Error,
+        variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>,
+        context: Context,
+      ) => void | Promise<void>
+    },
+  ): ((
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    MutationArgs<Url, undefined, QuerySchema>
+  >) &
+    MutationHelpers<Url, Result> &
+    StreamHelper<Method, Url, undefined, QuerySchema>
+
+  // Stream mutation GET methods without useKey, with querySchema
+  mutationFromEndpoint<
+    Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET',
+    Url extends string = string,
+    QuerySchema extends ZodObject = ZodObject,
+    Result = Blob,
+    Context = unknown,
+  >(
+    endpoint: {
+      config: BaseStreamConfig<Method, Url, QuerySchema, undefined>
+    },
+    mutationOptions?: {
+      processResponse?: ProcessResponseFunction<Result, Blob>
+      useContext?: () => Context
+      onSuccess?: (
+        queryClient: QueryClient,
+        data: NoInfer<Result>,
+        variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>,
+        context: Context,
+      ) => void | Promise<void>
+      onError?: (
+        queryClient: QueryClient,
+        error: Error,
+        variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>,
+        context: Context,
+      ) => void | Promise<void>
+    },
+  ): (() => UseMutationResult<
+    Result,
+    Error,
+    MutationArgs<Url, undefined, QuerySchema>
+  >) &
+    StreamHelper<Method, Url, undefined, QuerySchema>
+
+  // Stream mutation GET methods with useKey only (no schemas)
+  mutationFromEndpoint<
+    Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET',
+    Url extends string = string,
+    Result = Blob,
+    Context = unknown,
+    UseKey extends true = true,
+  >(
+    endpoint: {
+      config: BaseStreamConfig<Method, Url, undefined, undefined>
+    },
+    mutationOptions: {
+      processResponse?: ProcessResponseFunction<Result, Blob>
+      useKey: UseKey
+      useContext?: () => Context
+      onSuccess?: (
+        queryClient: QueryClient,
+        data: NoInfer<Result>,
+        variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>,
+        context: Context,
+      ) => void | Promise<void>
+      onError?: (
+        queryClient: QueryClient,
+        error: Error,
+        variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>,
+        context: Context,
+      ) => void | Promise<void>
+    },
+  ): ((
+    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    MutationArgs<Url, undefined, undefined>
+  >) &
+    MutationHelpers<Url, Result> &
+    StreamHelper<Method, Url, undefined, undefined>
+
+  // Stream mutation GET methods without useKey (no schemas)
+  mutationFromEndpoint<
+    Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET',
+    Url extends string = string,
+    Result = Blob,
+    Context = unknown,
+  >(
+    endpoint: {
+      config: BaseStreamConfig<Method, Url, undefined, undefined>
+    },
+    mutationOptions?: {
+      processResponse?: ProcessResponseFunction<Result, Blob>
+      useContext?: () => Context
+      onSuccess?: (
+        queryClient: QueryClient,
+        data: NoInfer<Result>,
+        variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>,
+        context: Context,
+      ) => void | Promise<void>
+      onError?: (
+        queryClient: QueryClient,
+        error: Error,
+        variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>,
+        context: Context,
+      ) => void | Promise<void>
+    },
+  ): (() => UseMutationResult<
+    Result,
+    Error,
+    MutationArgs<Url, undefined, undefined>
+  >) &
+    StreamHelper<Method, Url, undefined, undefined>
 }

package/src/mutation/make-hook.mts

@@ -48,7 +48,10 @@ export function makeMutation<
 ) {
   const config = endpoint.config
 
-  const mutationKey = createMutationKey(config, options)
+  const mutationKey = createMutationKey(config, {
+    ...options,
+    processResponse: options.processResponse ?? ((data) => data),
+  })
   const result = (
     keyParams: UseKey extends true
       ? UrlHasParams<Config['url']> extends true
@@ -91,7 +94,7 @@ export function makeMutation<
         async mutationFn(params: TVariables) {
           const response = await endpoint(params)
 
-          return processResponse(response) as TData
+          return (processResponse ? processResponse(response) : response) as TData
         },
         onSuccess: onSuccess
           ? (data: TData, variables: TVariables) => {

package/src/mutation/types.mts

@@ -48,7 +48,7 @@ export interface MutationParams<
     UseMutationOptions<TData, Error, TVariables>,
     'mutationKey' | 'mutationFn' | 'onSuccess' | 'onError' | 'scope'
   > {
-  processResponse: ProcessResponseFunction<TData, TResponse>
+  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