@navios/react-query 0.1.2 → 0.3.0

package/project.json

@@ -0,0 +1,53 @@
+{
+  "name": "@navios/react-query",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/react-query/src",
+  "prefix": "react-query",
+  "tags": [],
+  "projectType": "library",
+  "targets": {
+    "check": {
+      "executor": "nx:run-commands",
+      "outputs": ["{projectRoot}/dist"],
+      "inputs": ["^projectSources", "projectSources"],
+      "options": {
+        "command": ["tsc -b"],
+        "cwd": "packages/react-query"
+      }
+    },
+    "test:ci": {
+      "executor": "nx:run-commands",
+      "inputs": ["^projectSources", "project"],
+      "options": {
+        "command": "vitest run",
+        "cwd": "packages/react-query"
+      }
+    },
+    "build": {
+      "executor": "nx:run-commands",
+      "inputs": ["projectSources"],
+      "outputs": ["{projectRoot}/lib"],
+      "dependsOn": ["check", "test:ci"],
+      "options": {
+        "command": "tsup",
+        "cwd": "packages/react-query"
+      }
+    },
+    "publish": {
+      "executor": "nx:run-commands",
+      "dependsOn": ["build"],
+      "options": {
+        "command": "yarn npm publish --access public",
+        "cwd": "packages/react-query"
+      }
+    },
+    "publish:next": {
+      "executor": "nx:run-commands",
+      "dependsOn": ["build"],
+      "options": {
+        "command": "yarn npm publish --access public --tag next",
+        "cwd": "packages/react-query"
+      }
+    }
+  }
+}

package/src/__tests__/client-type-check.spec.mts

@@ -1,4 +1,4 @@
-import { builder } from '@navios/common'
+import { builder } from '@navios/builder'
 
 import { describe, expect, it } from 'vitest'
 import { z } from 'zod'

package/src/__tests__/declare-client.spec.mts

@@ -1,7 +1,7 @@
 import { create } from 'navios'
 import { makeNaviosFakeAdapter } from 'navios/testing'
 
-import { builder } from '@navios/common'
+import { builder } from '@navios/builder'
 
 import { describe, expect, it, vi } from 'vitest'
 import { z } from 'zod'
@@ -167,7 +167,6 @@ describe('declareClient', () => {
       },
     })
 
-    // @ts-expect-error it's internal type
     const mutationResult = mutation()
     const res = await mutationResult.mutateAsync({
       urlParams: {

package/src/__tests__/make-mutation.spec.mts

@@ -1,7 +1,7 @@
 import { create } from 'navios'
 import { makeNaviosFakeAdapter } from 'navios/testing'
 
-import { builder } from '@navios/common'
+import { builder } from '@navios/builder'
 
 import { describe, expect, it, vi } from 'vitest'
 import { z } from 'zod'

package/src/__tests__/makeDataTag.spec.mts

@@ -1,4 +1,4 @@
-import { builder } from '@navios/common'
+import { builder } from '@navios/builder'
 
 import { QueryClient } from '@tanstack/react-query'
 import { describe, expect, it } from 'vitest'

package/src/__tests__/makeInfiniteQueryOptions.spec.mts

@@ -1,4 +1,4 @@
-import { builder } from '@navios/common'
+import { builder } from '@navios/builder'
 
 import { describe, expect, it } from 'vitest'
 import { z } from 'zod'

package/src/__tests__/makeQueryOptions.spec.mts

@@ -1,4 +1,4 @@
-import { builder } from '@navios/common'
+import { builder } from '@navios/builder'
 
 import { describe, expect, it } from 'vitest'
 import { z } from 'zod'

package/src/declare-client.mts

@@ -3,7 +3,7 @@ import type {
   AnyEndpointConfig,
   HttpMethod,
   Util_FlatObject,
-} from '@navios/common'
+} from '@navios/builder'
 import type { InfiniteData, QueryClient } from '@tanstack/react-query'
 import type { AnyZodObject, z, ZodType } from 'zod'
 
@@ -211,6 +211,35 @@ export function declareClient<Options extends ClientOptions>({
     return useMutation
   }
 
+  function mutationFromEndpoint(
+    endpoint: AbstractEndpoint<AnyEndpointConfig>,
+    options: {
+      processResponse: ProcessResponseFunction
+      useContext?: () => unknown
+      onSuccess?: (
+        queryClient: QueryClient,
+        data: unknown,
+        variables: Util_FlatObject<ClientMutationArgs>,
+        context: unknown,
+      ) => void | Promise<void>
+      onError?: (
+        queryClient: QueryClient,
+        error: Error,
+        variables: Util_FlatObject<ClientMutationArgs>,
+        context: unknown,
+      ) => void | Promise<void>
+    },
+  ) {
+    return makeMutation(endpoint, {
+      processResponse: options.processResponse,
+      useContext: options.useContext,
+      onSuccess: options.onSuccess,
+      // @ts-expect-error simplify types here
+      onError: options.onError,
+      ...defaults,
+    })
+  }
+
   return {
     // @ts-expect-error We simplified types here
     query,
@@ -222,5 +251,7 @@ export function declareClient<Options extends ClientOptions>({
     infiniteQueryFromEndpoint,
     // @ts-expect-error We simplified types here
     mutation,
+    // @ts-expect-error We simplified types here
+    mutationFromEndpoint,
   }
 }

package/src/make-infinite-query-options.mts

@@ -2,7 +2,7 @@ import type {
   AbstractEndpoint,
   AnyEndpointConfig,
   UrlParams,
-} from '@navios/common'
+} from '@navios/builder'
 import type {
   InfiniteData,
   QueryClient,

package/src/make-mutation.mts

@@ -3,7 +3,7 @@ import type {
   AnyEndpointConfig,
   UrlHasParams,
   UrlParams,
-} from '@navios/common'
+} from '@navios/builder'
 import type { UseMutationResult } from '@tanstack/react-query'
 import type { z } from 'zod'
 

package/src/make-query-options.mts

@@ -1,4 +1,4 @@
-import type { AbstractEndpoint, AnyEndpointConfig } from '@navios/common'
+import type { AbstractEndpoint, AnyEndpointConfig } from '@navios/builder'
 import type {
   DataTag,
   QueryClient,

package/src/types/client-endpoint-helper.mts

@@ -3,7 +3,7 @@ import type {
   EndpointFunctionArgs,
   HttpMethod,
   Util_FlatObject,
-} from '@navios/common'
+} from '@navios/builder'
 import type { z } from 'zod'
 
 export type ClientEndpointHelper<

package/src/types/client-instance.mts

@@ -3,7 +3,7 @@ import type {
   UrlHasParams,
   UrlParams,
   Util_FlatObject,
-} from '@navios/common'
+} from '@navios/builder'
 import type {
   DataTag,
   InfiniteData,
@@ -182,13 +182,11 @@ export interface ClientInstance {
       >,
       context: Context,
     ) => void | Promise<void>
-  }): (
-    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
-  ) => UseMutationResult<
+  }): (() => UseMutationResult<
     Result,
     Error,
     ClientMutationArgs<Url, RequestSchema, QuerySchema>
-  > &
+  >) &
     ClientEndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>
 
   mutation<
@@ -222,9 +220,7 @@ export interface ClientInstance {
       >,
       context: Context,
     ) => void | Promise<void>
-  }): ((
-    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
-  ) => UseMutationResult<
+  }): (() => UseMutationResult<
     Result,
     Error,
     ClientMutationArgs<Url, RequestSchema, undefined>
@@ -266,7 +262,7 @@ export interface ClientInstance {
       context: Context,
     ) => void | Promise<void>
   }): ((
-    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+    params: UrlHasParams<Url> extends true ? UrlParams<Url> : {},
   ) => UseMutationResult<
     Result,
     Error,
@@ -309,7 +305,7 @@ export interface ClientInstance {
       context: Context,
     ) => void | Promise<void>
   }): ((
-    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+    params: UrlHasParams<Url> extends true ? UrlParams<Url> : {},
   ) => UseMutationResult<
     Result,
     Error,
@@ -349,13 +345,11 @@ export interface ClientInstance {
       >,
       context: Context,
     ) => void | Promise<void>
-  }): (
-    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
-  ) => UseMutationResult<
+  }): (() => UseMutationResult<
     Result,
     Error,
     ClientMutationArgs<Url, undefined, QuerySchema>
-  > &
+  >) &
     ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>
 
   mutation<
@@ -386,7 +380,7 @@ export interface ClientInstance {
       context: Context,
     ) => void | Promise<void>
   }): ((
-    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
+    params: UrlHasParams<Url> extends true ? UrlParams<Url> : {},
   ) => UseMutationResult<
     Result,
     Error,
@@ -420,13 +414,11 @@ export interface ClientInstance {
       variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>,
       context: Context,
     ) => void | Promise<void>
-  }): (
-    params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
-  ) => UseMutationResult<
+  }): (() => UseMutationResult<
     Result,
     Error,
     ClientMutationArgs<Url, undefined, undefined>
-  > &
+  >) &
     ClientEndpointHelper<Method, Url, undefined, Response>
 
   queryFromEndpoint<
@@ -464,14 +456,14 @@ export interface ClientInstance {
     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<
@@ -500,7 +492,7 @@ export interface ClientInstance {
         allPageParams: z.infer<QuerySchema>[] | undefined,
       ) => z.input<QuerySchema>
     },
-  ): (
+  ): ((
     params: UrlHasParams<Url> extends true ? { urlParams: UrlParams<Url> } : {},
   ) => UseSuspenseInfiniteQueryOptions<
     PageResult,
@@ -509,6 +501,364 @@ export interface ClientInstance {
     PageResult,
     DataTag<Split<Url, '/'>, PageResult, Error>,
     z.output<QuerySchema>
-  > &
+  >) &
     QueryHelpers<Url, QuerySchema, PageResult, true>
+
+  mutationFromEndpoint<
+    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,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<
+        Method,
+        Url,
+        QuerySchema,
+        Response,
+        RequestSchema
+      >
+    },
+    mutationOptions: {
+      processResponse: ProcessResponseFunction<Result, ReqResult>
+      useKey: UseKey
+      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<Url> : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, RequestSchema, QuerySchema>
+  >) &
+    MutationHelpers<Url, Result> &
+    ClientEndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>
+
+  mutationFromEndpoint<
+    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,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<
+        Method,
+        Url,
+        undefined,
+        Response,
+        RequestSchema
+      >
+    },
+    mutationOptions: {
+      processResponse: ProcessResponseFunction<Result, ReqResult>
+      useKey: UseKey
+      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<Url> : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, RequestSchema, undefined>
+  >) &
+    MutationHelpers<Url, Result> &
+    ClientEndpointHelper<Method, Url, RequestSchema, Response, undefined>
+
+  mutationFromEndpoint<
+    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,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<
+        Method,
+        Url,
+        QuerySchema,
+        Response,
+        RequestSchema
+      >
+    },
+    mutationOptions: {
+      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>
+    },
+  ): (() => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, RequestSchema, QuerySchema>
+  >) &
+    ClientEndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>
+
+  mutationFromEndpoint<
+    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,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<
+        Method,
+        Url,
+        undefined,
+        Response,
+        RequestSchema
+      >
+    },
+    mutationOptions: {
+      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>
+    },
+  ): (() => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, RequestSchema, undefined>
+  >) &
+    ClientEndpointHelper<Method, Url, RequestSchema, Response, undefined>
+
+  mutationFromEndpoint<
+    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,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<Method, Url, QuerySchema, Response>
+    },
+    mutationOptions: {
+      processResponse: ProcessResponseFunction<Result, ReqResult>
+      useKey: UseKey
+      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<Url> : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, undefined, QuerySchema>
+  >) &
+    MutationHelpers<Url, Result> &
+    ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>
+
+  mutationFromEndpoint<
+    Method extends 'DELETE' = 'DELETE',
+    Url extends string = string,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+    UseKey extends true = true,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<Method, Url, undefined, Response>
+    },
+    mutationOptions: {
+      processResponse: ProcessResponseFunction<Result, ReqResult>
+      useKey: UseKey
+      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<Url> : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, undefined, undefined>
+  >) &
+    MutationHelpers<Url, Result> &
+    ClientEndpointHelper<Method, Url, undefined, Response, undefined>
+
+  mutationFromEndpoint<
+    Method extends 'DELETE' = 'DELETE',
+    Url extends string = string,
+    QuerySchema extends AnyZodObject = AnyZodObject,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<Method, Url, QuerySchema, Response>
+    },
+    mutationOptions: {
+      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>
+    },
+  ): (() => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, undefined, QuerySchema>
+  >) &
+    ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>
+
+  mutationFromEndpoint<
+    Method extends 'DELETE' = 'DELETE',
+    Url extends string = string,
+    Response extends ZodType = ZodType,
+    ReqResult = z.output<Response>,
+    Result = unknown,
+    Context = unknown,
+  >(
+    endpoint: any & {
+      config: BaseEndpointConfig<Method, Url, undefined, Response>
+    },
+    mutationOptions: {
+      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<Url> : {},
+  ) => UseMutationResult<
+    Result,
+    Error,
+    ClientMutationArgs<Url, undefined, undefined>
+  >) &
+    ClientEndpointHelper<Method, Url, undefined, Response, undefined>
 }

package/src/types/mutation-args.mts

@@ -1,4 +1,4 @@
-import type { UrlHasParams, UrlParams } from '@navios/common'
+import type { UrlHasParams, UrlParams } from '@navios/builder'
 import type { AnyZodObject, z } from 'zod'
 
 export type ClientMutationArgs<

package/src/types/mutation-helpers.mts

@@ -1,4 +1,4 @@
-import type { UrlHasParams, UrlParams } from '@navios/common'
+import type { UrlHasParams, UrlParams } from '@navios/builder'
 import type { DataTag } from '@tanstack/react-query'
 
 export type MutationHelpers<Url extends string, Result = unknown> =