@navios/react-query 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -1,346 +1,26 @@
-import * as _navios_common from '@navios/common';
-import { AnyEndpointConfig, BuilderInstance, NaviosZodRequest, UrlHasParams, BaseEndpointConfig, HttpMethod, UrlParams, Util_FlatObject, AbstractEndpoint } from '@navios/common';
-import * as _tanstack_react_query from '@tanstack/react-query';
-import { UseMutationOptions, QueryClient, DataTag, InfiniteData, UseQueryResult, UseSuspenseQueryResult, UseSuspenseQueryOptions, UseSuspenseInfiniteQueryOptions, UseMutationResult, UseInfiniteQueryOptions, UseQueryOptions } from '@tanstack/react-query';
-import { z, AnyZodObject, ZodType } from 'zod';
-
-type Split$2<S extends string, D extends string> = string extends S ? string[] : S extends '' ? [] : S extends `${infer T}${D}${infer U}` ? [T, ...Split$2<U, D>] : [S];
-type ProcessResponseFunction<TData = unknown, TVariables = unknown> = (variables: TVariables) => Promise<TData> | TData;
-type ClientOptions<ProcessResponse = unknown> = {
-    api: BuilderInstance;
-    defaults?: {
-        keyPrefix?: string[];
-        keySuffix?: string[];
-    };
-};
-type BaseQueryParams<Config extends AnyEndpointConfig, Res = any> = {
-    keyPrefix?: string[];
-    keySuffix?: string[];
-    onFail?: (err: unknown) => void;
-    processResponse: (data: z.output<Config['responseSchema']>) => Res;
-};
-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;
-}
-type BaseQueryArgs<Config extends AnyEndpointConfig> = (UrlHasParams<Config['url']> extends true ? {
-    urlParams: UrlParams<Config['url']>;
-} : {}) & (Config['querySchema'] extends AnyZodObject ? {
-    params: z.input<Config['querySchema']>;
-} : {});
-type BaseMutationArgs<Config extends AnyEndpointConfig> = NaviosZodRequest<Config>;
-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']>;
-};
-
-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>;
-} : {});
-
-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;
-};
-
-type ClientQueryArgs<Url extends string = string, QuerySchema = AnyZodObject> = (UrlHasParams<Url> extends true ? {
-    urlParams: UrlParams<Url>;
-} : {}) & (QuerySchema extends AnyZodObject ? {
-    params: z.input<QuerySchema>;
-} : {});
-
-type Split$1<S extends string, D extends string> = string extends S ? string[] : S extends '' ? [] : S extends `${infer T}${D}${infer U}` ? [T, ...Split$1<U, D>] : [S];
-type QueryKeyCreatorResult<QuerySchema = undefined, Url extends string = string, Result = unknown, IsInfinite extends boolean = false, HasParams extends UrlHasParams<Url> = UrlHasParams<Url>> = {
-    template: Split$1<Url, '/'>;
-    dataTag: (params: (HasParams extends true ? {
-        urlParams: UrlParams<Url>;
-    } : {}) & (QuerySchema extends AnyZodObject ? {
-        params: z.input<QuerySchema>;
-    } : {})) => DataTag<Split$1<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
-    filterKey: (params: HasParams extends true ? {
-        urlParams: UrlParams<Url>;
-    } : {}) => DataTag<Split$1<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
-    bindToUrl: (params: (HasParams extends true ? {
-        urlParams: UrlParams<Url>;
-    } : {}) & (QuerySchema extends AnyZodObject ? {
-        params: z.infer<QuerySchema>;
-    } : {})) => string;
-};
-declare function queryKeyCreator<Config extends AnyEndpointConfig, Options extends BaseQueryParams<Config>, IsInfinite extends boolean, Url extends Config['url'] = Config['url'], HasParams extends UrlHasParams<Url> = UrlHasParams<Url>>(config: Config, options: Options, isInfinite: IsInfinite): QueryKeyCreatorResult<Config['querySchema'], Url, Options['processResponse'] extends (...args: any[]) => infer Result ? Result : never, IsInfinite, HasParams>;
-
-type ClientQueryUrlParamsArgs<Url extends string = string> = UrlHasParams<Url> extends true ? {
-    urlParams: UrlParams<Url>;
-} : {} | undefined;
-
-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>;
-};
-
-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$2<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$2<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$2<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$2<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$2<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$2<Url, '/'>, PageResult, Error>, z.output<QuerySchema>> & QueryHelpers<Url, QuerySchema, PageResult, true>;
-}
-
-/**
- * Creates a mutation key for a given endpoint configuration and options.
- *
- * @param {config: Config } config - The endpoint object containing the configuration.
- * @param {Options} [options] - Optional query parameters with a default `processResponse` function that processes the response data.
- *
- * @returns {Object} An object containing the `mutationKey` function.
- *
- * The `mutationKey` function generates a mutation key based on the provided parameters:
- * - If the URL has parameters (`HasParams` is `true`), it expects an object with `urlParams`.
- * - The return type of the `mutationKey` function depends on the `processResponse` function in `options`.
- *   If `processResponse` is defined, the return type is a `DataTag` containing the processed result and an error type.
- *
- * @example Example usage:
- * ```typescript
- * const createMutationKey = mutationKeyCreator(endpoint.config);
- * const mutationKey = createMutationKey({ urlParams: { id: 123 } });
- * ```
- *
- * @example Advanced usage:
- * ```ts
- * const createMutationKey = mutationKeyCreator(endpoint.config, {
- *   processResponse: (data) => {
- *     if (!data.success) {
- *      throw new Error(data.message);
- *     }
- *     return data.data;
- *   },
- * });
- * // We create a mutation that will be shared across the project for all passed userId
- * const mutationKey = createMutationKey({ urlParams: { projectId: 123, userId: 'wildcard' } });
- */
-declare function mutationKeyCreator<Config extends AnyEndpointConfig, Options extends BaseQueryParams<Config>, Url extends Config['url'] = Config['url'], HasParams extends UrlHasParams<Url> = UrlHasParams<Url>>(config: Config, options?: Options): (params: HasParams extends true ? {
-    urlParams: UrlParams<Url>;
-} : {}) => Options['processResponse'] extends (...args: any[]) => infer Result ? DataTag<[Config['url']], Result, Error> : never;
-
-interface ClientEndpoint<Method = HttpMethod, Url = string, QuerySchema = unknown, Response = ZodType> {
-    method: Method;
-    url: Url;
-    querySchema?: QuerySchema;
-    responseSchema: Response;
-}
-interface ClientQueryConfig<Method = HttpMethod, Url = string, QuerySchema = AnyZodObject, Response extends ZodType = ZodType, Result = z.output<Response>> extends ClientEndpoint<Method, Url, QuerySchema, Response> {
-    processResponse?: (data: z.output<Response>) => Result;
-}
-type ClientInfiniteQueryConfig<Method = HttpMethod, Url = string, QuerySchema extends AnyZodObject = AnyZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>> = Required<ClientEndpoint<Method, Url, QuerySchema, Response>> & {
-    processResponse?: (data: z.output<Response>) => PageResult;
-    select?: (data: InfiniteData<PageResult>) => Result;
-    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>;
-    initialPageParam?: z.input<QuerySchema>;
-};
-interface ClientMutationDataConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' = 'POST' | 'PUT' | 'PATCH' | 'DELETE', Url extends string = string, RequestSchema = Method extends 'DELETE' ? never : AnyZodObject, QuerySchema = unknown, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends boolean = false> extends ClientEndpoint<Method, Url, QuerySchema, Response> {
-    requestSchema?: RequestSchema;
-    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>;
-    useKey?: UseKey;
-}
-declare function declareClient<Options extends ClientOptions>({ api, defaults, }: Options): ClientInstance;
-
-declare function makeMutation<Config extends AnyEndpointConfig, TData = unknown, TVariables extends BaseMutationArgs<Config> = BaseMutationArgs<Config>, TResponse = z.output<Config['responseSchema']>, TContext = unknown, UseKey extends boolean = false>(endpoint: AbstractEndpoint<Config>, options: BaseMutationParams<Config, TData, TVariables, TResponse, TContext, UseKey>): {
-    (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, BaseMutationArgs<Config>>;
-    useIsMutating(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): boolean;
-    mutationKey: (params: UrlHasParams<Config["url"]> extends infer T ? T extends UrlHasParams<Config["url"]> ? T extends true ? {
-        urlParams: UrlParams<Config["url"]>;
-    } : {} : never : never) => [Config["url"]] & {
-        [dataTagSymbol]: TData | Promise<TData>;
-        [dataTagErrorSymbol]: Error;
-    };
-};
-
-declare function makeInfiniteQueryOptions<Config extends AnyEndpointConfig, Options extends InfiniteQueryOptions<Config>, BaseQuery extends Omit<UseInfiniteQueryOptions<ReturnType<Options['processResponse']>, Error, any>, 'queryKey' | 'queryFn' | 'getNextPageParam' | 'initialPageParam' | 'placeholderData' | 'throwOnError'>>(endpoint: AbstractEndpoint<Config>, options: Options, baseQuery?: BaseQuery): {
-    (params: ClientQueryArgs): Options["processResponse"] extends (...args: any[]) => infer Result ? UseSuspenseInfiniteQueryOptions<Result, Error, BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<Result>> : never;
-    queryKey: QueryKeyCreatorResult<Config["querySchema"], Config["url"], Options["processResponse"] extends (...args: any[]) => infer Result ? Result : never, true, _navios_common.UrlHasParams<Config["url"]>>;
-    use(params: ClientQueryArgs): _tanstack_react_query.UseInfiniteQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<unknown, unknown>, Error>;
-    useSuspense(params: ClientQueryArgs): _tanstack_react_query.UseSuspenseInfiniteQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<unknown, unknown>, Error>;
-    invalidate(queryClient: QueryClient, params: ClientQueryArgs): Promise<void>;
-    invalidateAll(queryClient: QueryClient, params: ClientQueryArgs): Promise<void>;
-};
-
-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];
-declare function makeQueryOptions<Config extends AnyEndpointConfig, Options extends BaseQueryParams<Config>, BaseQuery extends Omit<UseQueryOptions<ReturnType<Options['processResponse']>, Error, any>, 'queryKey' | 'queryFn' | 'getNextPageParam' | 'initialPageParam' | 'enabled' | 'throwOnError' | 'placeholderData'>>(endpoint: AbstractEndpoint<Config>, options: Options, baseQuery?: BaseQuery): {
-    (params: BaseQueryArgs<Config>): Options["processResponse"] extends (...args: any[]) => infer Result ? UseSuspenseQueryOptions<Result, Error, BaseQuery["select"] extends (...args: any[]) => infer T ? T : Result, DataTag<Split<Config["url"], "/">, Result, Error>> : never;
-    queryKey: QueryKeyCreatorResult<Config["querySchema"], Config["url"], Options["processResponse"] extends (...args: any[]) => infer Result ? Result : never, false, _navios_common.UrlHasParams<Config["url"]>>;
-    use(params: ClientQueryArgs): _tanstack_react_query.DefinedUseInfiniteQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : unknown, Error>;
-    useSuspense(params: ClientQueryArgs): _tanstack_react_query.UseSuspenseInfiniteQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : unknown, Error>;
-    invalidate(queryClient: QueryClient, params: ClientQueryArgs): Promise<void>;
-    invalidateAll(queryClient: QueryClient, params: ClientQueryArgs): Promise<void>;
-};
-
-export { type BaseMutationArgs, type BaseMutationParams, type BaseQueryArgs, type BaseQueryParams, type ClientEndpoint, type ClientInfiniteQueryConfig, type ClientInstance, type ClientMutationArgs, type ClientMutationDataConfig, type ClientOptions, type ClientQueryArgs, type ClientQueryConfig, type ClientQueryUrlParamsArgs, type InfiniteQueryOptions, type MutationHelpers, type ProcessResponseFunction, type QueryHelpers, type QueryKeyCreatorResult, type Split$2 as Split, declareClient, makeInfiniteQueryOptions, makeMutation, makeQueryOptions, mutationKeyCreator, queryKeyCreator };
+export { ClientEndpointHelper } from './_tsup-dts-rollup.js';
+export { ClientInstance } from './_tsup-dts-rollup.js';
+export { ClientMutationArgs } from './_tsup-dts-rollup.js';
+export { MutationHelpers } from './_tsup-dts-rollup.js';
+export { ClientQueryArgs } from './_tsup-dts-rollup.js';
+export { QueryHelpers } from './_tsup-dts-rollup.js';
+export { ClientQueryUrlParamsArgs } from './_tsup-dts-rollup.js';
+export { mutationKeyCreator } from './_tsup-dts-rollup.js';
+export { queryKeyCreator } from './_tsup-dts-rollup.js';
+export { QueryKeyCreatorResult } from './_tsup-dts-rollup.js';
+export { declareClient_alias_1 as declareClient } from './_tsup-dts-rollup.js';
+export { ClientEndpointDefinition_alias_1 as ClientEndpointDefinition } from './_tsup-dts-rollup.js';
+export { ClientQueryConfig_alias_1 as ClientQueryConfig } from './_tsup-dts-rollup.js';
+export { ClientInfiniteQueryConfig_alias_1 as ClientInfiniteQueryConfig } from './_tsup-dts-rollup.js';
+export { ClientMutationDataConfig_alias_1 as ClientMutationDataConfig } from './_tsup-dts-rollup.js';
+export { makeMutation } from './_tsup-dts-rollup.js';
+export { makeInfiniteQueryOptions } from './_tsup-dts-rollup.js';
+export { makeQueryOptions } from './_tsup-dts-rollup.js';
+export { Split } from './_tsup-dts-rollup.js';
+export { ProcessResponseFunction } from './_tsup-dts-rollup.js';
+export { ClientOptions } from './_tsup-dts-rollup.js';
+export { BaseQueryParams } from './_tsup-dts-rollup.js';
+export { BaseMutationParams } from './_tsup-dts-rollup.js';
+export { BaseQueryArgs } from './_tsup-dts-rollup.js';
+export { BaseMutationArgs } from './_tsup-dts-rollup.js';
+export { InfiniteQueryOptions } from './_tsup-dts-rollup.js';

package/dist/index.js

@@ -264,10 +264,12 @@ function declareClient({
       querySchema: config.querySchema,
       responseSchema: config.responseSchema
     });
-    return makeQueryOptions(endpoint, {
+    const queryOptions2 = makeQueryOptions(endpoint, {
       ...defaults,
       processResponse: config.processResponse ?? ((data) => data)
     });
+    queryOptions2.endpoint = endpoint;
+    return queryOptions2;
   }
   function queryFromEndpoint(endpoint, options) {
     return makeQueryOptions(endpoint, {
@@ -283,13 +285,15 @@ function declareClient({
       querySchema: config.querySchema,
       responseSchema: config.responseSchema
     });
-    return makeInfiniteQueryOptions(endpoint, {
+    const infiniteQueryOptions2 = makeInfiniteQueryOptions(endpoint, {
       ...defaults,
       processResponse: config.processResponse ?? ((data) => data),
       getNextPageParam: config.getNextPageParam,
       getPreviousPageParam: config.getPreviousPageParam,
       initialPageParam: config.initialPageParam
     });
+    infiniteQueryOptions2.endpoint = endpoint;
+    return infiniteQueryOptions2;
   }
   function infiniteQueryFromEndpoint(endpoint, options) {
     return makeInfiniteQueryOptions(endpoint, {
@@ -309,7 +313,7 @@ function declareClient({
       requestSchema: config.requestSchema,
       responseSchema: config.responseSchema
     });
-    return makeMutation(endpoint, {
+    const useMutation2 = makeMutation(endpoint, {
       processResponse: config.processResponse ?? ((data) => data),
       useContext: config.useContext,
       // @ts-expect-error We forgot about the DELETE method in original makeMutation
@@ -319,6 +323,8 @@ function declareClient({
       useKey: config.useKey,
       ...defaults
     });
+    useMutation2.endpoint = endpoint;
+    return useMutation2;
   }
   return {
     // @ts-expect-error We simplified types here
@@ -342,4 +348,3 @@ function declareClient({
   mutationKeyCreator,
   queryKeyCreator
 });
-//# sourceMappingURL=index.js.map

package/dist/index.mjs

@@ -245,10 +245,12 @@ function declareClient({
       querySchema: config.querySchema,
       responseSchema: config.responseSchema
     });
-    return makeQueryOptions(endpoint, {
+    const queryOptions2 = makeQueryOptions(endpoint, {
       ...defaults,
       processResponse: config.processResponse ?? ((data) => data)
     });
+    queryOptions2.endpoint = endpoint;
+    return queryOptions2;
   }
   function queryFromEndpoint(endpoint, options) {
     return makeQueryOptions(endpoint, {
@@ -264,13 +266,15 @@ function declareClient({
       querySchema: config.querySchema,
       responseSchema: config.responseSchema
     });
-    return makeInfiniteQueryOptions(endpoint, {
+    const infiniteQueryOptions2 = makeInfiniteQueryOptions(endpoint, {
       ...defaults,
       processResponse: config.processResponse ?? ((data) => data),
       getNextPageParam: config.getNextPageParam,
       getPreviousPageParam: config.getPreviousPageParam,
       initialPageParam: config.initialPageParam
     });
+    infiniteQueryOptions2.endpoint = endpoint;
+    return infiniteQueryOptions2;
   }
   function infiniteQueryFromEndpoint(endpoint, options) {
     return makeInfiniteQueryOptions(endpoint, {
@@ -290,7 +294,7 @@ function declareClient({
       requestSchema: config.requestSchema,
       responseSchema: config.responseSchema
     });
-    return makeMutation(endpoint, {
+    const useMutation2 = makeMutation(endpoint, {
       processResponse: config.processResponse ?? ((data) => data),
       useContext: config.useContext,
       // @ts-expect-error We forgot about the DELETE method in original makeMutation
@@ -300,6 +304,8 @@ function declareClient({
       useKey: config.useKey,
       ...defaults
     });
+    useMutation2.endpoint = endpoint;
+    return useMutation2;
   }
   return {
     // @ts-expect-error We simplified types here
@@ -322,4 +328,3 @@ export {
   mutationKeyCreator,
   queryKeyCreator
 };
-//# sourceMappingURL=index.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@navios/react-query",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "author": {
     "name": "Oleksandr Hanzha",
     "email": "alex@granted.name"
@@ -15,7 +15,7 @@
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "peerDependencies": {
-    "@navios/common": "^0.1.0",
+    "@navios/common": "^0.1.1",
     "@tanstack/react-query": "^5.51.21",
     "zod": "^3.23.8"
   },
@@ -33,11 +33,11 @@
     "./package.json": "./package.json"
   },
   "devDependencies": {
-    "@navios/common": "^0.1.0",
-    "@tanstack/react-query": "^5.75.1",
+    "@navios/common": "^0.1.1",
+    "@tanstack/react-query": "^5.75.7",
     "navios": "^0.4.0",
     "react": "^19.1.0",
     "typescript": "^5.8.3",
-    "zod": "^3.24.3"
+    "zod": "^3.24.4"
   }
 }

package/src/declare-client.mts

@@ -14,7 +14,7 @@ import { makeInfiniteQueryOptions } from './make-infinite-query-options.mjs'
 import { makeMutation } from './make-mutation.mjs'
 import { makeQueryOptions } from './make-query-options.mjs'
 
-export interface ClientEndpoint<
+export interface ClientEndpointDefinition<
   Method = HttpMethod,
   Url = string,
   QuerySchema = unknown,
@@ -32,7 +32,7 @@ export interface ClientQueryConfig<
   QuerySchema = AnyZodObject,
   Response extends ZodType = ZodType,
   Result = z.output<Response>,
-> extends ClientEndpoint<Method, Url, QuerySchema, Response> {
+> extends ClientEndpointDefinition<Method, Url, QuerySchema, Response> {
   processResponse?: (data: z.output<Response>) => Result
 }
 
@@ -43,7 +43,7 @@ export type ClientInfiniteQueryConfig<
   Response extends ZodType = ZodType,
   PageResult = z.output<Response>,
   Result = InfiniteData<PageResult>,
-> = Required<ClientEndpoint<Method, Url, QuerySchema, Response>> & {
+> = Required<ClientEndpointDefinition<Method, Url, QuerySchema, Response>> & {
   processResponse?: (data: z.output<Response>) => PageResult
   select?: (data: InfiniteData<PageResult>) => Result
   getNextPageParam: (
@@ -75,7 +75,7 @@ export interface ClientMutationDataConfig<
   Result = unknown,
   Context = unknown,
   UseKey extends boolean = false,
-> extends ClientEndpoint<Method, Url, QuerySchema, Response> {
+> extends ClientEndpointDefinition<Method, Url, QuerySchema, Response> {
   requestSchema?: RequestSchema
   processResponse: ProcessResponseFunction<Result, ReqResult>
   useContext?: () => Context
@@ -111,10 +111,13 @@ export function declareClient<Options extends ClientOptions>({
       responseSchema: config.responseSchema,
     })
 
-    return makeQueryOptions(endpoint, {
+    const queryOptions = makeQueryOptions(endpoint, {
       ...defaults,
       processResponse: config.processResponse ?? ((data) => data),
     })
+    // @ts-expect-error We attach the endpoint to the queryOptions
+    queryOptions.endpoint = endpoint
+    return queryOptions
   }
 
   function queryFromEndpoint(
@@ -139,13 +142,17 @@ export function declareClient<Options extends ClientOptions>({
       querySchema: config.querySchema,
       responseSchema: config.responseSchema,
     })
-    return makeInfiniteQueryOptions(endpoint, {
+    const infiniteQueryOptions = makeInfiniteQueryOptions(endpoint, {
       ...defaults,
       processResponse: config.processResponse ?? ((data) => data),
       getNextPageParam: config.getNextPageParam,
       getPreviousPageParam: config.getPreviousPageParam,
       initialPageParam: config.initialPageParam,
     })
+
+    // @ts-expect-error We attach the endpoint to the infiniteQueryOptions
+    infiniteQueryOptions.endpoint = endpoint
+    return infiniteQueryOptions
   }
 
   function infiniteQueryFromEndpoint(
@@ -188,7 +195,7 @@ export function declareClient<Options extends ClientOptions>({
       responseSchema: config.responseSchema,
     })
 
-    return makeMutation(endpoint, {
+    const useMutation = makeMutation(endpoint, {
       processResponse: config.processResponse ?? ((data) => data),
       useContext: config.useContext,
       // @ts-expect-error We forgot about the DELETE method in original makeMutation
@@ -198,6 +205,10 @@ export function declareClient<Options extends ClientOptions>({
       useKey: config.useKey,
       ...defaults,
     })
+
+    // @ts-expect-error We attach the endpoint to the useMutation
+    useMutation.endpoint = endpoint
+    return useMutation
   }
 
   return {

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

@@ -0,0 +1,29 @@
+import type {
+  BaseEndpointConfig,
+  EndpointFunctionArgs,
+  HttpMethod,
+  Util_FlatObject,
+} from '@navios/common'
+import type { z } from 'zod'
+
+export type ClientEndpointHelper<
+  Method extends HttpMethod = HttpMethod,
+  Url extends string = string,
+  RequestSchema = unknown,
+  ResponseSchema extends z.ZodType = z.ZodType,
+  QuerySchema = unknown,
+> = {
+  endpoint: ((
+    params: Util_FlatObject<
+      EndpointFunctionArgs<Url, QuerySchema, RequestSchema>
+    >,
+  ) => Promise<z.output<ResponseSchema>>) & {
+    config: BaseEndpointConfig<
+      Method,
+      Url,
+      QuerySchema,
+      ResponseSchema,
+      RequestSchema
+    >
+  }
+}