mobx-tanstack-query-api 0.26.2 → 0.27.0

package/index.d.ts

@@ -1,9 +1,9 @@
 import * as _tanstack_query_core from '@tanstack/query-core';
 import { InvalidateOptions, DefaultError, RefetchOptions, QueryObserverResult, QueryFunctionContext, InvalidateQueryFilters, InfiniteData, QueryKey } from '@tanstack/query-core';
 export * from '@tanstack/query-core';
+import { HttpStatusCode, HttpSuccessStatusCode } from 'http-status-code-types';
 import { QueryClient, QueryClientConfig, Query, QueryUpdateOptionsAllVariants, QueryConfig, InfiniteQueryConfig, InfiniteQueryOptions, InfiniteQueryUpdateOptions, InfiniteQueryDynamicOptions, InfiniteQuery, MutationInvalidateQueriesOptions, MutationConfig, Mutation, IQueryClientCore } from 'mobx-tanstack-query';
 import { MaybeFalsy, AnyObject, Maybe, MaybeFn, ValueOf, Defined, IsPartial } from 'yummies/types';
-import { HttpStatusCode, HttpSuccessStatusCode } from 'http-status-code-types';
 import { IStringifyOptions, BooleanOptional } from 'qs';
 
 /**
@@ -303,6 +303,10 @@ declare class Endpoint<TResponse extends AnyResponse, TParams extends AnyObject,
     get operationId(): string;
     get group(): string | undefined;
     get namespace(): string | undefined;
+    checkResponse<TStatus extends HttpStatusCode>(response: unknown, status: TStatus): response is Extract<TResponse, {
+        status: TStatus;
+    }>;
+    checkResponse(response: unknown): response is TResponse;
     request(...args: IsPartial<TParams> extends true ? [params?: Maybe<TParams>] : [params: TParams]): Promise<TResponse>;
     toQueryMeta: (meta?: AnyObject) => {
         tags: string[];
@@ -328,7 +332,7 @@ declare class Endpoint<TResponse extends AnyResponse, TParams extends AnyObject,
         options?: InvalidateOptions
     ]): void;
     toMutation<TData = TResponse['data'], TMutationMeta extends AnyObject | void = void, TContext = unknown>(options: EndpointMutationOptions<this, TData, TParams, TMutationMeta, TContext>): EndpointMutation<this, TData, TParams, TMutationMeta, TContext>;
-    toQuery<TQueryFnData = TResponse['data'], TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData>(options: EndpointQueryOptions<this, TQueryFnData, TError, TData, TQueryData> | (() => EndpointQueryFlattenOptions<this, TQueryFnData, TError, TData, TQueryData>)): EndpointQuery<this, TQueryFnData, TError, TData, TQueryData>;
+    toQuery<TQueryFnData = TResponse['data'], TError = DefaultError | Defined<TResponse['error']>, TData = TQueryFnData, TQueryData = TQueryFnData>(options: EndpointQueryOptions<this, TQueryFnData, TError, TData, TQueryData> | (() => EndpointQueryFlattenOptions<this, TQueryFnData, TError, TData, TQueryData>)): EndpointQuery<this, TQueryFnData, TError, TData, TQueryData>;
     toInfiniteQuery<TData = TResponse['data'], TError = DefaultError, TPageParam = unknown>(options: EndpointInfiniteQueryOptions<this, TData, TError, TPageParam> | (() => EndpointInfiniteQueryFlattenOptions<this, TData, TError, TPageParam>)): EndpointInfiniteQuery<this, TData, TError, TPageParam, _tanstack_query_core.InfiniteData<TData, TPageParam>>;
 }
 

package/index.js

@@ -388,6 +388,176 @@ class EndpointMutation extends Mutation {
     this.endpoint = endpoint;
   }
 }
+const isHttpResponse = (response, status) => !!response && typeof response === "object" && response instanceof Response && "data" in response && (!status || response.status === status);
+const isHttpBadResponse = (response) => {
+  return isHttpResponse(response) && (!response.ok || !!response.error);
+};
+class HttpClient {
+  config;
+  fetch;
+  meta;
+  baseApiParams;
+  badResponse;
+  toQueryString;
+  constructor(config) {
+    this.config = config ?? {};
+    this.badResponse = null;
+    this.meta = config?.meta ?? null;
+    this.fetch = config?.fetch ?? ((...fetchParams) => globalThis.fetch(...fetchParams));
+    this.toQueryString = config?.toQueryString ?? ((query) => stringify(query, config?.queryStringifyOptions));
+    this.baseApiParams = {
+      credentials: "same-origin",
+      headers: {},
+      redirect: "follow",
+      referrerPolicy: "no-referrer"
+    };
+    this.updateConfig(this.config);
+    observable.ref(this, "badResponse");
+    observable.ref(this, "meta");
+    action(this, "setMeta");
+    action(this, "setBadResponse");
+    makeObservable(this);
+  }
+  get baseUrl() {
+    return this.config.baseUrl ?? "";
+  }
+  updateConfig(update) {
+    Object.assign(this.config, update);
+    if (update.baseApiParams) {
+      Object.assign(this.baseApiParams, update.baseApiParams);
+    }
+    if (update.contentFormatters) {
+      Object.assign(this.contentFormatters, update.contentFormatters);
+    }
+    if (update.fetch) {
+      this.fetch = update.fetch;
+    }
+  }
+  setMeta = (data) => {
+    this.meta = data;
+  };
+  setBadResponse = (response) => {
+    this.badResponse = response;
+  };
+  contentFormatters = {
+    "application/json": (input) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
+    "text/plain": (input) => input !== null && typeof input !== "string" ? JSON.stringify(input) : input,
+    "multipart/form-data": (input) => Object.keys(input || {}).reduce((formData, key) => {
+      const property = input[key];
+      if (property instanceof Blob) {
+        formData.append(key, property);
+      } else if (typeof property === "object" && property !== null) {
+        formData.append(key, JSON.stringify(property));
+      } else {
+        formData.append(key, `${property}`);
+      }
+      return formData;
+    }, new FormData()),
+    "application/x-www-form-urlencoded": (input) => this.toQueryString(input),
+    "application/octet-stream": (input) => input
+  };
+  mergeRequestParams(params1, params2) {
+    return {
+      ...this.baseApiParams,
+      ...params1,
+      ...params2,
+      headers: {
+        ...this.baseApiParams.headers,
+        ...params1.headers,
+        ...params2?.headers
+      }
+    };
+  }
+  async createResponse(responseFormat, raw, url, params) {
+    const response = raw;
+    response.request = {
+      url,
+      params
+    };
+    response.data = null;
+    response.error = null;
+    if (responseFormat) {
+      try {
+        const formatted = await response[responseFormat]();
+        if (response.ok) {
+          response.data = formatted;
+        } else {
+          response.error = formatted;
+        }
+      } catch (error) {
+        if (response.ok) {
+          response.error = error;
+        } else {
+          response.error = null;
+        }
+      }
+    }
+    if (!response.ok || response.error) {
+      this.setBadResponse(response);
+    }
+    return response;
+  }
+  buildUrl = (params) => {
+    const baseUrl = params.baseUrl ?? this.baseUrl ?? "";
+    const path = params.path;
+    const queryString = params.query && this.toQueryString(params.query);
+    const query = queryString ? `?${queryString}` : "";
+    if (this.config.buildUrl) {
+      return this.config.buildUrl(params, { baseUrl, path, query }, this.meta);
+    }
+    const url = baseUrl + path + query;
+    return url;
+  };
+  async request(fullParams, endpoint) {
+    this.setBadResponse(null);
+    const {
+      body,
+      contentType = "application/json",
+      format = "json",
+      ...params
+    } = fullParams;
+    let requestParams = this.mergeRequestParams(params);
+    if (this.config.interceptor) {
+      requestParams = await this.config.interceptor(requestParams, this.meta, endpoint) ?? requestParams;
+    }
+    const payloadFormatter = this.contentFormatters[contentType];
+    const responseFormat = format || requestParams.format;
+    const url = this.buildUrl(fullParams);
+    let headers;
+    if (requestParams.headers instanceof Headers) {
+      headers = requestParams.headers;
+    } else if (Array.isArray(requestParams.headers)) {
+      headers = new Headers(requestParams.headers);
+    } else {
+      headers = new Headers(requestParams.headers);
+    }
+    if (!headers.has("Content-Type")) {
+      headers.set("Content-Type", contentType);
+    }
+    const fetchUrl = url;
+    const fetchParams = {
+      ...requestParams,
+      headers,
+      body: body == null ? null : payloadFormatter(body)
+    };
+    let response;
+    try {
+      response = await this.fetch(fetchUrl, fetchParams);
+    } catch (error) {
+      response = error;
+    }
+    const httpResponse = await this.createResponse(
+      responseFormat,
+      response,
+      fetchUrl,
+      fetchParams
+    );
+    if (!httpResponse.ok || httpResponse.error) {
+      throw httpResponse;
+    }
+    return httpResponse;
+  }
+}
 class Endpoint {
   constructor(configuration, queryClient, httpClient) {
     this.configuration = configuration;
@@ -443,6 +613,9 @@ class Endpoint {
   get namespace() {
     return this.configuration.namespace;
   }
+  checkResponse(response, status) {
+    return isHttpResponse(response, status);
+  }
   request(...args) {
     return this.httpClient.request(
       this.configuration.params(args[0] ?? {}),
@@ -584,176 +757,6 @@ const applyStringFilter = (filter, value) => {
   }
   return values.includes(filter);
 };
-const isHttpResponse = (response, status) => !!response && typeof response === "object" && response instanceof Response && "data" in response && (!status || response.status === status);
-const isHttpBadResponse = (response) => {
-  return isHttpResponse(response) && (!response.ok || !!response.error);
-};
-class HttpClient {
-  config;
-  fetch;
-  meta;
-  baseApiParams;
-  badResponse;
-  toQueryString;
-  constructor(config) {
-    this.config = config ?? {};
-    this.badResponse = null;
-    this.meta = config?.meta ?? null;
-    this.fetch = config?.fetch ?? ((...fetchParams) => globalThis.fetch(...fetchParams));
-    this.toQueryString = config?.toQueryString ?? ((query) => stringify(query, config?.queryStringifyOptions));
-    this.baseApiParams = {
-      credentials: "same-origin",
-      headers: {},
-      redirect: "follow",
-      referrerPolicy: "no-referrer"
-    };
-    this.updateConfig(this.config);
-    observable.ref(this, "badResponse");
-    observable.ref(this, "meta");
-    action(this, "setMeta");
-    action(this, "setBadResponse");
-    makeObservable(this);
-  }
-  get baseUrl() {
-    return this.config.baseUrl ?? "";
-  }
-  updateConfig(update) {
-    Object.assign(this.config, update);
-    if (update.baseApiParams) {
-      Object.assign(this.baseApiParams, update.baseApiParams);
-    }
-    if (update.contentFormatters) {
-      Object.assign(this.contentFormatters, update.contentFormatters);
-    }
-    if (update.fetch) {
-      this.fetch = update.fetch;
-    }
-  }
-  setMeta = (data) => {
-    this.meta = data;
-  };
-  setBadResponse = (response) => {
-    this.badResponse = response;
-  };
-  contentFormatters = {
-    "application/json": (input) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
-    "text/plain": (input) => input !== null && typeof input !== "string" ? JSON.stringify(input) : input,
-    "multipart/form-data": (input) => Object.keys(input || {}).reduce((formData, key) => {
-      const property = input[key];
-      if (property instanceof Blob) {
-        formData.append(key, property);
-      } else if (typeof property === "object" && property !== null) {
-        formData.append(key, JSON.stringify(property));
-      } else {
-        formData.append(key, `${property}`);
-      }
-      return formData;
-    }, new FormData()),
-    "application/x-www-form-urlencoded": (input) => this.toQueryString(input),
-    "application/octet-stream": (input) => input
-  };
-  mergeRequestParams(params1, params2) {
-    return {
-      ...this.baseApiParams,
-      ...params1,
-      ...params2,
-      headers: {
-        ...this.baseApiParams.headers,
-        ...params1.headers,
-        ...params2?.headers
-      }
-    };
-  }
-  async createResponse(responseFormat, raw, url, params) {
-    const response = raw;
-    response.request = {
-      url,
-      params
-    };
-    response.data = null;
-    response.error = null;
-    if (responseFormat) {
-      try {
-        const formatted = await response[responseFormat]();
-        if (response.ok) {
-          response.data = formatted;
-        } else {
-          response.error = formatted;
-        }
-      } catch (error) {
-        if (response.ok) {
-          response.error = error;
-        } else {
-          response.error = null;
-        }
-      }
-    }
-    if (!response.ok || response.error) {
-      this.setBadResponse(response);
-    }
-    return response;
-  }
-  buildUrl = (params) => {
-    const baseUrl = params.baseUrl ?? this.baseUrl ?? "";
-    const path = params.path;
-    const queryString = params.query && this.toQueryString(params.query);
-    const query = queryString ? `?${queryString}` : "";
-    if (this.config.buildUrl) {
-      return this.config.buildUrl(params, { baseUrl, path, query }, this.meta);
-    }
-    const url = baseUrl + path + query;
-    return url;
-  };
-  async request(fullParams, endpoint) {
-    this.setBadResponse(null);
-    const {
-      body,
-      contentType = "application/json",
-      format = "json",
-      ...params
-    } = fullParams;
-    let requestParams = this.mergeRequestParams(params);
-    if (this.config.interceptor) {
-      requestParams = await this.config.interceptor(requestParams, this.meta, endpoint) ?? requestParams;
-    }
-    const payloadFormatter = this.contentFormatters[contentType];
-    const responseFormat = format || requestParams.format;
-    const url = this.buildUrl(fullParams);
-    let headers;
-    if (requestParams.headers instanceof Headers) {
-      headers = requestParams.headers;
-    } else if (Array.isArray(requestParams.headers)) {
-      headers = new Headers(requestParams.headers);
-    } else {
-      headers = new Headers(requestParams.headers);
-    }
-    if (!headers.has("Content-Type")) {
-      headers.set("Content-Type", contentType);
-    }
-    const fetchUrl = url;
-    const fetchParams = {
-      ...requestParams,
-      headers,
-      body: body == null ? null : payloadFormatter(body)
-    };
-    let response;
-    try {
-      response = await this.fetch(fetchUrl, fetchParams);
-    } catch (error) {
-      response = error;
-    }
-    const httpResponse = await this.createResponse(
-      responseFormat,
-      response,
-      fetchUrl,
-      fetchParams
-    );
-    if (!httpResponse.ok || httpResponse.error) {
-      throw httpResponse;
-    }
-    return httpResponse;
-  }
-}
 export {
   Endpoint,
   EndpointMutation,