mobx-tanstack-query-api 0.41.0 → 0.42.0

package/index.js

@@ -2,14 +2,12 @@ import { hashKey } from "@tanstack/query-core";
 export * from "@tanstack/query-core";
 import { callFunction } from "yummies/common";
 import { makeObservable, observable, runInAction, comparer, computed, reaction, action } from "mobx";
-import { Query, InfiniteQuery, Mutation, QueryClient } from "mobx-tanstack-query";
+import { InfiniteQuery, Mutation, Query, QueryClient } from "mobx-tanstack-query";
 import { getMobxAdministration, lazyObserve } from "yummies/mobx";
 import { stringify } from "qs";
-class EndpointQuery extends Query {
+class EndpointInfiniteQuery extends InfiniteQuery {
   /**
-   * Creates `EndpointQuery` instance.
-   *
-   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#constructor)
+   * Creates `EndpointInfiniteQuery` instance.
    */
   constructor(endpoint, inputQueryClient, queryOptionsInput) {
     const isQueryOptionsInputFn = typeof queryOptionsInput === "function";
@@ -20,6 +18,7 @@ class EndpointQuery extends Query {
       params,
       onDone: onDoneInput,
       queryClient: overridedQueryClient,
+      mergePageParam,
       ...queryOptions
     } = unpackedQueryOptionsInput;
     const queryClient = overridedQueryClient ?? inputQueryClient;
@@ -27,7 +26,9 @@ class EndpointQuery extends Query {
       params: null,
       dynamicOptions: void 0,
       response: null,
-      uniqKey: unpackedQueryOptionsInput.uniqKey
+      uniqKey: unpackedQueryOptionsInput.uniqKey,
+      transform: transformResponse,
+      mergePageParam
     };
     if (!isQueryOptionsInputFn && typeof params !== "function") {
       if ("params" in unpackedQueryOptionsInput) {
@@ -40,7 +41,9 @@ class EndpointQuery extends Query {
     makeObservable(_observableData, {
       params: observable.ref,
       response: observable.ref,
-      dynamicOptions: observable
+      dynamicOptions: observable,
+      transform: observable.ref,
+      mergePageParam: observable.ref
     });
     const onDone = onDoneInput && ((...args) => {
       onDoneInput(...args);
@@ -51,7 +54,7 @@ class EndpointQuery extends Query {
       queryClient,
       meta: endpoint.toQueryMeta(queryOptions.meta),
       options: () => {
-        const builtOptions = buildOptionsFromParams(
+        const builtOptions = buildInfiniteOptionsFromParams(
           endpoint,
           _observableData.params,
           _observableData.uniqKey
@@ -74,7 +77,13 @@ class EndpointQuery extends Query {
             _observableData.params = params2;
           }
         });
-        let requestParams = params2.requestParams;
+        const mergedParams = mergeInfiniteQueryPageParam(
+          params2,
+          ctx.pageParam ?? queryOptions.initialPageParam,
+          ctx,
+          _observableData.mergePageParam
+        );
+        let requestParams = mergedParams.requestParams;
         if (requestParams) {
           if (!requestParams.signal) {
             requestParams.signal = ctx.signal;
@@ -83,14 +92,14 @@ class EndpointQuery extends Query {
           requestParams = { signal: ctx.signal };
         }
         const fixedInput = {
-          ...params2,
+          ...mergedParams,
           requestParams
         };
         const response = await endpoint.request(fixedInput);
         runInAction(() => {
           _observableData.response = response;
         });
-        return await transformResponse?.(response) ?? response.data;
+        return await _observableData.transform?.(response) ?? response.data;
       }
     });
     this.endpoint = endpoint;
@@ -103,6 +112,8 @@ class EndpointQuery extends Query {
         () => {
           let outDynamicOptions;
           let outParams;
+          let outTransform;
+          let outMergePageParam;
           let uniqKey2;
           if (isQueryOptionsInputFn) {
             const result = queryOptionsInput();
@@ -115,9 +126,14 @@ class EndpointQuery extends Query {
               onInit,
               enableOnDemand,
               uniqKey: _uniqKey,
+              transform,
+              mergePageParam: mergePageParam2,
+              queryClient: queryClient2,
               ...dynamicOptions
             } = result;
             uniqKey2 = _uniqKey;
+            outTransform = transform;
+            outMergePageParam = mergePageParam2;
             if ("params" in result) {
               outParams = result.params;
             } else {
@@ -127,22 +143,30 @@ class EndpointQuery extends Query {
           } else if ("params" in unpackedQueryOptionsInput) {
             outParams = unpackedQueryOptionsInput.params;
             uniqKey2 = unpackedQueryOptionsInput.uniqKey;
+            outTransform = unpackedQueryOptionsInput.transform;
+            outMergePageParam = unpackedQueryOptionsInput.mergePageParam;
           } else {
             outParams = {};
             uniqKey2 = unpackedQueryOptionsInput.uniqKey;
+            outTransform = unpackedQueryOptionsInput.transform;
+            outMergePageParam = unpackedQueryOptionsInput.mergePageParam;
           }
           return {
             params: callFunction(outParams),
             dynamicOptions: outDynamicOptions,
-            uniqKey: uniqKey2
+            uniqKey: uniqKey2,
+            transform: outTransform,
+            mergePageParam: outMergePageParam
           };
         },
-        ({ params: params2, dynamicOptions, uniqKey: uniqKey2 }) => {
+        ({ params: params2, dynamicOptions, uniqKey: uniqKey2, transform, mergePageParam: mergePageParam2 }) => {
           runInAction(() => {
             _observableData.initialized = true;
             _observableData.params = params2;
             _observableData.dynamicOptions = dynamicOptions;
             _observableData.uniqKey = uniqKey2;
+            _observableData.transform = transform;
+            _observableData.mergePageParam = mergePageParam2;
           });
         },
         {
@@ -166,75 +190,59 @@ class EndpointQuery extends Query {
   }
   _observableData;
   /**
-   * Current endpoint params used by this query.
-   *
-   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#params)
+   * Current base endpoint params used for `queryKey`.
    */
   get params() {
     return this._observableData.params;
   }
   /**
    * Last raw HTTP response returned by endpoint.
-   *
-   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#response)
    */
   get response() {
     return this._observableData.response;
   }
   /**
-   * Updates query options and optionally params.
-   *
-   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#update)
+   * Updates query options and optionally base params.
    */
   update(updateParams) {
     if ("params" in updateParams) {
       const { params, ...options } = updateParams;
-      runInAction(() => {
-        this._observableData.params = params;
-      });
-      return super.update({
-        ...buildOptionsFromParams(
-          this.endpoint,
-          params,
-          this._observableData.uniqKey
-        ),
-        ...options
-      });
-    } else if (this._observableData) {
+      if (this._observableData) {
+        runInAction(() => {
+          this._observableData.params = params;
+        });
+        return super.update({
+          ...buildInfiniteOptionsFromParams(
+            this.endpoint,
+            params,
+            this._observableData.uniqKey
+          ),
+          ...options
+        });
+      }
+      return super.update(options);
+    }
+    if (this._observableData) {
       return super.update({
-        ...buildOptionsFromParams(
+        ...buildInfiniteOptionsFromParams(
           this.endpoint,
           this._observableData.params,
           this._observableData.uniqKey
         ),
         ...updateParams
       });
-    } else {
-      return super.update(updateParams);
-    }
-  }
-  /**
-   * Refetches query when params are initialized.
-   *
-   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#refetch)
-   */
-  refetch(options) {
-    if (this.params) {
-      return super.refetch(options);
     }
-    return Promise.resolve(this.queryObserver.getCurrentResult());
+    return super.update(updateParams);
   }
   /**
-   * Sets params and starts query execution.
-   *
-   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#start)
+   * Sets base params and starts the infinite query execution.
    */
   async start(params) {
     runInAction(() => {
       this._observableData.params = params;
     });
     return await super.start(
-      buildOptionsFromParams(
+      buildInfiniteOptionsFromParams(
         this.endpoint,
         params,
         this._observableData.uniqKey
@@ -246,13 +254,60 @@ class EndpointQuery extends Query {
     runInAction(() => {
       this._observableData.params = void 0;
       this._observableData.dynamicOptions = void 0;
+      this._observableData.transform = void 0;
+      this._observableData.mergePageParam = void 0;
     });
   }
 }
-const getParamsFromContext = (ctx) => {
-  return ctx.queryKey.at(-2) || {};
-};
-const buildOptionsFromParams = (endpoint, params, uniqKey) => {
+function ensureObjectPageParam(pageParam, mergePageParam) {
+  if (typeof pageParam === "object" && pageParam !== null && !Array.isArray(pageParam)) {
+    return pageParam;
+  }
+  throw new Error(
+    `[mobx-tanstack-query-api] "${mergePageParam}" mergePageParam expects an object pageParam. Use a custom mergePageParam function for primitive page params.`
+  );
+}
+function mergeInfiniteQueryPageParam(params, pageParam, ctx, mergePageParam) {
+  if (pageParam == null || !mergePageParam) {
+    return params;
+  }
+  if (typeof mergePageParam === "function") {
+    return mergePageParam(params, pageParam, ctx) || {};
+  }
+  const objectPageParam = ensureObjectPageParam(pageParam, mergePageParam);
+  switch (mergePageParam) {
+    case "params":
+      return {
+        ...params,
+        ...objectPageParam
+      };
+    case "body":
+      return {
+        ...params,
+        body: {
+          ...params.body,
+          ...objectPageParam
+        }
+      };
+    case "query":
+      return {
+        ...params,
+        query: {
+          ...params.query,
+          ...objectPageParam
+        }
+      };
+    case "headers":
+      return {
+        ...params,
+        headers: {
+          ...params.headers,
+          ...objectPageParam
+        }
+      };
+  }
+}
+const buildInfiniteOptionsFromParams = (endpoint, params, uniqKey) => {
   const { requiredParams } = endpoint.configuration;
   let hasRequiredParams = false;
   if (requiredParams.length > 0) {
@@ -262,99 +317,9 @@ const buildOptionsFromParams = (endpoint, params, uniqKey) => {
   }
   return {
     enabled: hasRequiredParams,
-    queryKey: endpoint.toQueryKey(params || {}, uniqKey)
+    queryKey: endpoint.toInfiniteQueryKey(params || {}, uniqKey)
   };
 };
-class EndpointInfiniteQuery extends InfiniteQuery {
-  constructor(endpoint, queryClient, queryOptionsInput) {
-    const {
-      uniqKey,
-      transform: transformResponse,
-      params: paramsFn,
-      ...queryOptions
-    } = typeof queryOptionsInput === "function" ? queryOptionsInput() : queryOptionsInput;
-    super({
-      ...queryOptions,
-      queryClient,
-      meta: endpoint.toQueryMeta(queryOptions.meta),
-      options: (query) => {
-        const extraOptions = {};
-        let willEnableManually;
-        let params;
-        const pageParam = query.options.initialPageParam;
-        if (typeof queryOptionsInput === "function") {
-          Object.assign(extraOptions, queryOptionsInput());
-          params = paramsFn(pageParam);
-          willEnableManually = false;
-        } else {
-          willEnableManually = queryOptionsInput.enabled === false;
-          params = paramsFn(pageParam);
-        }
-        const builtOptions = buildOptionsFromParams(endpoint, params, uniqKey);
-        let isEnabled = false;
-        if (willEnableManually) ;
-        else {
-          isEnabled = builtOptions.enabled;
-        }
-        return {
-          ...query.options,
-          ...builtOptions,
-          // ...dynamicOuterOptions,
-          enabled: isEnabled,
-          ...extraOptions
-        };
-      },
-      queryFn: async (ctx) => {
-        const params = paramsFn(
-          ctx.pageParam ?? queryOptions.initialPageParam
-        );
-        runInAction(() => {
-          this.response = null;
-          this.params = params;
-        });
-        let requestParams = params.request;
-        if (requestParams) {
-          if (!requestParams.signal) {
-            requestParams.signal = ctx.signal;
-          }
-        } else {
-          requestParams = { signal: ctx.signal };
-        }
-        const fixedInput = {
-          ...params,
-          request: requestParams
-        };
-        const response = await endpoint.request(fixedInput);
-        runInAction(() => {
-          this.response = response;
-        });
-        return await transformResponse?.(response) ?? response.data;
-      }
-    });
-    this.endpoint = endpoint;
-    this.uniqKey = uniqKey;
-    observable.ref(this, "response");
-    observable.ref(this, "params");
-    makeObservable(this);
-  }
-  response = null;
-  params = null;
-  uniqKey;
-  update({
-    params,
-    ...options
-  }) {
-    return super.update({
-      ...buildOptionsFromParams(this.endpoint, params, this.uniqKey),
-      ...options
-    });
-  }
-  async start(params) {
-    return await super.start(
-      buildOptionsFromParams(this.endpoint, params, this.uniqKey)
-    );
-  }
-}
 class EndpointMutation extends Mutation {
   /**
    * Creates `EndpointMutation` instance.
@@ -425,6 +390,266 @@ class EndpointMutation extends Mutation {
     });
   }
 }
+class EndpointQuery extends Query {
+  /**
+   * Creates `EndpointQuery` instance.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#constructor)
+   */
+  constructor(endpoint, inputQueryClient, queryOptionsInput) {
+    const isQueryOptionsInputFn = typeof queryOptionsInput === "function";
+    const unpackedQueryOptionsInput = isQueryOptionsInputFn ? queryOptionsInput() : queryOptionsInput;
+    const {
+      uniqKey,
+      transform: transformResponse,
+      params,
+      onDone: onDoneInput,
+      queryClient: overridedQueryClient,
+      ...queryOptions
+    } = unpackedQueryOptionsInput;
+    const queryClient = overridedQueryClient ?? inputQueryClient;
+    const _observableData = {
+      params: null,
+      dynamicOptions: void 0,
+      response: null,
+      uniqKey: unpackedQueryOptionsInput.uniqKey
+    };
+    if (!isQueryOptionsInputFn && typeof params !== "function") {
+      if ("params" in unpackedQueryOptionsInput) {
+        _observableData.params = params;
+      } else {
+        _observableData.params = {};
+      }
+      _observableData.initialized = true;
+    }
+    makeObservable(_observableData, {
+      params: observable.ref,
+      response: observable.ref,
+      dynamicOptions: observable
+    });
+    const onDone = onDoneInput && ((...args) => {
+      onDoneInput(...args);
+    });
+    super({
+      ...queryOptions,
+      onDone,
+      queryClient,
+      meta: endpoint.toQueryMeta(queryOptions.meta),
+      options: () => {
+        const builtOptions = buildOptionsFromParams(
+          endpoint,
+          _observableData.params,
+          _observableData.uniqKey
+        );
+        let isEnabled = !!_observableData.initialized && builtOptions.enabled;
+        if (typeof queryOptionsInput !== "function" && queryOptionsInput.enabled === false) {
+          isEnabled = false;
+        }
+        return {
+          ...builtOptions,
+          enabled: isEnabled,
+          ..._observableData.dynamicOptions
+        };
+      },
+      queryFn: async (ctx) => {
+        const params2 = endpoint.getParamsFromContext(ctx);
+        runInAction(() => {
+          _observableData.response = null;
+          if (!comparer.structural(params2, _observableData.params)) {
+            _observableData.params = params2;
+          }
+        });
+        let requestParams = params2.requestParams;
+        if (requestParams) {
+          if (!requestParams.signal) {
+            requestParams.signal = ctx.signal;
+          }
+        } else {
+          requestParams = { signal: ctx.signal };
+        }
+        const fixedInput = {
+          ...params2,
+          requestParams
+        };
+        const response = await endpoint.request(fixedInput);
+        runInAction(() => {
+          _observableData.response = response;
+        });
+        return await transformResponse?.(response) ?? response.data;
+      }
+    });
+    this.endpoint = endpoint;
+    const parentAtom = getMobxAdministration(this);
+    computed.struct(this, "params");
+    computed.struct(this, "response");
+    makeObservable(this);
+    if (isQueryOptionsInputFn || typeof params === "function") {
+      const createParamsReaction = () => reaction(
+        () => {
+          let outDynamicOptions;
+          let outParams;
+          let uniqKey2;
+          if (isQueryOptionsInputFn) {
+            const result = queryOptionsInput();
+            const {
+              params: params2,
+              abortSignal,
+              select,
+              onDone: onDone2,
+              onError,
+              onInit,
+              enableOnDemand,
+              uniqKey: _uniqKey,
+              ...dynamicOptions
+            } = result;
+            uniqKey2 = _uniqKey;
+            if ("params" in result) {
+              outParams = result.params;
+            } else {
+              outParams = {};
+            }
+            outDynamicOptions = Object.keys(dynamicOptions).length > 0 ? dynamicOptions : void 0;
+          } else if ("params" in unpackedQueryOptionsInput) {
+            outParams = unpackedQueryOptionsInput.params;
+            uniqKey2 = unpackedQueryOptionsInput.uniqKey;
+          } else {
+            outParams = {};
+            uniqKey2 = unpackedQueryOptionsInput.uniqKey;
+          }
+          return {
+            params: callFunction(outParams),
+            dynamicOptions: outDynamicOptions,
+            uniqKey: uniqKey2
+          };
+        },
+        ({ params: params2, dynamicOptions, uniqKey: uniqKey2 }) => {
+          runInAction(() => {
+            _observableData.initialized = true;
+            _observableData.params = params2;
+            _observableData.dynamicOptions = dynamicOptions;
+            _observableData.uniqKey = uniqKey2;
+          });
+        },
+        {
+          fireImmediately: true
+        }
+      );
+      if (this.features.lazy) {
+        lazyObserve({
+          property: parentAtom.values_.get("_result"),
+          onStart: createParamsReaction,
+          onEnd: (disposeFn) => disposeFn()
+        });
+      } else {
+        this.abortController.signal.addEventListener(
+          "abort",
+          createParamsReaction()
+        );
+      }
+    }
+    this._observableData = _observableData;
+  }
+  _observableData;
+  /**
+   * Current endpoint params used by this query.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#params)
+   */
+  get params() {
+    return this._observableData.params;
+  }
+  /**
+   * Last raw HTTP response returned by endpoint.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#response)
+   */
+  get response() {
+    return this._observableData.response;
+  }
+  /**
+   * Updates query options and optionally params.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#update)
+   */
+  update(updateParams) {
+    if ("params" in updateParams) {
+      const { params, ...options } = updateParams;
+      runInAction(() => {
+        this._observableData.params = params;
+      });
+      return super.update({
+        ...buildOptionsFromParams(
+          this.endpoint,
+          params,
+          this._observableData.uniqKey
+        ),
+        ...options
+      });
+    } else if (this._observableData) {
+      return super.update({
+        ...buildOptionsFromParams(
+          this.endpoint,
+          this._observableData.params,
+          this._observableData.uniqKey
+        ),
+        ...updateParams
+      });
+    } else {
+      return super.update(updateParams);
+    }
+  }
+  /**
+   * Refetches query when params are initialized.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#refetch)
+   */
+  refetch(options) {
+    if (this.params) {
+      return super.refetch(options);
+    }
+    return Promise.resolve(this.queryObserver.getCurrentResult());
+  }
+  /**
+   * Sets params and starts query execution.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoint-queries/#start)
+   */
+  async start(params) {
+    runInAction(() => {
+      this._observableData.params = params;
+    });
+    return await super.start(
+      buildOptionsFromParams(
+        this.endpoint,
+        params,
+        this._observableData.uniqKey
+      )
+    );
+  }
+  handleDestroy() {
+    super.handleDestroy();
+    runInAction(() => {
+      this._observableData.params = void 0;
+      this._observableData.dynamicOptions = void 0;
+    });
+  }
+}
+const getParamsFromContext = (ctx) => {
+  return ctx.queryKey.at(-2) || {};
+};
+const buildOptionsFromParams = (endpoint, params, uniqKey) => {
+  const { requiredParams } = endpoint.configuration;
+  let hasRequiredParams = false;
+  if (requiredParams.length > 0) {
+    hasRequiredParams = !!params && requiredParams.every((param) => param in params);
+  } else {
+    hasRequiredParams = !!params;
+  }
+  return {
+    enabled: hasRequiredParams,
+    queryKey: endpoint.toQueryKey(params || {}, uniqKey)
+  };
+};
 const emptyStatusCodesSet = /* @__PURE__ */ new Set([204, 205, 304]);
 class HttpResponse {
   constructor(originalResponse, request) {
@@ -488,6 +713,65 @@ function isContractOptionEnabled(option, key) {
   return option === true || typeof option === "object" && option !== null && option[key] === true;
 }
 class Endpoint {
+  /**
+   * Unique runtime identifier of the endpoint instance.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#endpointid)
+   */
+  endpointId;
+  /**
+   * Mutable presets used by helper factory methods like `toMutation()`.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#presets)
+   */
+  presets = {
+    mutations: {}
+  };
+  /**
+   * Type-only helper that exposes endpoint params shape.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#__params)
+   */
+  __params;
+  /**
+   * Type-only helper that exposes endpoint response shape.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#__response)
+   */
+  __response;
+  /**
+   * Custom metadata attached to the endpoint configuration.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#meta)
+   */
+  meta;
+  /**
+   * Endpoint configuration generated from the contract/codegen layer.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#configuration)
+   */
+  configuration;
+  /**
+   * Query client used by query and mutation helpers.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#queryclient)
+   */
+  queryClient;
+  /**
+   * HTTP client used to build URLs and execute requests.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#httpclient)
+   */
+  httpClient;
+  validateParams = false;
+  validateData = false;
+  throwParams = false;
+  throwData = false;
+  /**
+   * Creates a callable `Endpoint` instance.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#constructor)
+   */
   constructor(configuration, queryClient, httpClient) {
     this.configuration = configuration;
     this.queryClient = queryClient;
@@ -512,43 +796,77 @@ class Endpoint {
     });
     return callable;
   }
-  endpointId;
-  presets = {
-    mutations: {}
-  };
-  __params;
-  __response;
-  meta;
-  validateParams = false;
-  validateData = false;
-  throwParams = false;
-  throwData = false;
+  /**
+   * Returns a fully resolved request URL for the provided params.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#getfullurl)
+   */
   getFullUrl(...args) {
     const params = this.configuration.params(args[0] ?? {});
     return this.httpClient.buildUrl(params);
   }
+  /**
+   * Returns the resolved request path without the base URL.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#getpath)
+   */
   getPath(...args) {
     const params = this.configuration.params(args[0] ?? {});
     return params.path;
   }
+  /**
+   * Extracts endpoint params from TanStack Query function context.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#getparamsfromcontext)
+   */
   getParamsFromContext(ctx) {
     return ctx.queryKey.at(-2) || {};
   }
+  /**
+   * Tags declared for the endpoint.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#tags)
+   */
   get tags() {
     return this.configuration.tags;
   }
+  /**
+   * Path segments declared for the endpoint.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#path)
+   */
   get path() {
     return this.configuration.path;
   }
+  /**
+   * Slash-joined path declaration for the endpoint.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#pathdeclaration)
+   */
   get pathDeclaration() {
     return this.path.join("/");
   }
+  /**
+   * Operation identifier from the endpoint configuration.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#operationid)
+   */
   get operationId() {
     return this.configuration.operationId;
   }
+  /**
+   * Optional endpoint group.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#group)
+   */
   get group() {
     return this.configuration.group;
   }
+  /**
+   * Optional endpoint namespace.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#namespace)
+   */
   get namespace() {
     return this.configuration.namespace;
   }
@@ -587,6 +905,11 @@ class Endpoint {
       }
     }
   }
+  /**
+   * Performs the HTTP request and optionally validates contracts.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#request)
+   */
   async request(...args) {
     const rawParams = args[0] ?? {};
     const contract = this.configuration.contract;
@@ -613,6 +936,11 @@ class Endpoint {
     }
     return response;
   }
+  /**
+   * Builds query metadata payload enriched with endpoint fields.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#toquerymeta)
+   */
   toQueryMeta = (meta) => ({
     ...meta,
     tags: this.tags,
@@ -622,6 +950,11 @@ class Endpoint {
     endpointId: this.endpointId,
     endpointQuery: true
   });
+  /**
+   * Builds a stable TanStack Query key for a regular query.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#toquerykey)
+   */
   toQueryKey(params, uniqKey) {
     return [
       ...this.configuration.path,
@@ -630,6 +963,11 @@ class Endpoint {
       callFunction(uniqKey)
     ];
   }
+  /**
+   * Builds a stable TanStack Query key for an infinite query.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#toinfinitequerykey)
+   */
   toInfiniteQueryKey(params, uniqKey) {
     return [
       { infiniteQuery: true },
@@ -639,6 +977,11 @@ class Endpoint {
       callFunction(uniqKey)
     ];
   }
+  /**
+   * Invalidates the exact query produced by this endpoint.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#invalidatequery)
+   */
   invalidateQuery(...args) {
     this.queryClient.invalidateQueries(
       {
@@ -649,6 +992,11 @@ class Endpoint {
       args[2]
     );
   }
+  /**
+   * Creates an `EndpointMutation` bound to this endpoint.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#tomutation)
+   */
   toMutation(options) {
     return new EndpointMutation(
       this,
@@ -659,6 +1007,11 @@ class Endpoint {
       }
     );
   }
+  /**
+   * Creates an `EndpointQuery` bound to this endpoint.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#toquery)
+   */
   toQuery(options) {
     return new EndpointQuery(
       this,
@@ -666,12 +1019,13 @@ class Endpoint {
       options
     );
   }
+  /**
+   * Creates an `EndpointInfiniteQuery` bound to this endpoint.
+   *
+   * [**Documentation**](https://js2me.github.io/mobx-tanstack-query-api/endpoints/#toinfinitequery)
+   */
   toInfiniteQuery(options) {
-    return new EndpointInfiniteQuery(
-      this,
-      this.queryClient,
-      options
-    );
+    return new EndpointInfiniteQuery(this, this.queryClient, options);
   }
 }
 class EndpointQueryClient extends QueryClient {
@@ -933,15 +1287,18 @@ class HttpClient {
 export {
   ContentType,
   Endpoint,
+  EndpointInfiniteQuery,
   EndpointMutation,
   EndpointQuery,
   EndpointQueryClient,
   HttpClient,
   HttpResponse,
+  buildInfiniteOptionsFromParams,
   buildOptionsFromParams,
   emptyStatusCodesSet,
   getParamsFromContext,
   isHttpBadResponse,
-  isHttpResponse
+  isHttpResponse,
+  mergeInfiniteQueryPageParam
 };
 //# sourceMappingURL=index.js.map