@ethlete/query 2.1.1 → 2.2.0

package/lib/query/query.types.d.ts

@@ -178,6 +178,9 @@ export interface Cancelled {
 export interface QueryStateMeta {
     id: number;
     triggeredVia: QueryTrigger;
+    isWaitingForRetry?: boolean;
+    retryNumber?: number;
+    retryDelay?: number;
 }
 export interface QueryStateSuccessMeta extends QueryStateMeta {
     expiresAt?: number;

package/lib/query-client/query-client.types.d.ts

@@ -1,7 +1,7 @@
 import { BehaviorSubject } from 'rxjs';
 import { Query } from '../query/query';
 import { BaseArguments, EmptyObject, RouteType, WithHeaders, WithUseResultIn } from '../query/query.types';
-import { CacheAdapterFn, Method as MethodType, RequestHeaders, RequestHeadersMethodMap } from '../request';
+import { CacheAdapterFn, Method as MethodType, RequestHeaders, RequestHeadersMethodMap, RequestRetryFn } from '../request';
 import { QueryClient } from './query-client';
 export interface QueryClientConfig {
     /**
@@ -49,6 +49,11 @@ export interface QueryClientConfig {
          * @default true
          */
         enableSmartPolling?: boolean;
+        /**
+         * A retry function to be used for all queries.
+         * @default shouldRetryRequest()
+         */
+        retryFn?: RequestRetryFn;
     };
     /**
      * Parent query client.

package/lib/request/request.types.d.ts

@@ -24,6 +24,16 @@ export interface PartialXhrState {
     statusText: string;
     url: string;
 }
+export interface RequestRetryFnConfig {
+    error: RequestError;
+    headers: RequestHeaders;
+    currentRetryCount: number;
+}
+export interface RequestRetryFnResult {
+    retry: boolean;
+    delay?: number;
+}
+export type RequestRetryFn = (config: RequestRetryFnConfig) => RequestRetryFnResult;
 export interface RequestConfig {
     method: Method;
     urlWithParams: string;
@@ -33,6 +43,7 @@ export interface RequestConfig {
     responseType?: 'arraybuffer' | 'blob' | 'json' | 'text';
     headers?: RequestHeaders;
     cacheAdapter?: CacheAdapterFn;
+    retryFn?: RequestRetryFn;
 }
 export type RequestProgress = {
     current: number;
@@ -42,6 +53,14 @@ export type RequestProgress = {
 export type RequestEvent<Response = unknown> = {
     type: 'start';
     headers: RequestHeaders;
+    isRetry?: boolean;
+    retryNumber?: number;
+    retryDelay?: number;
+} | {
+    type: 'delay-retry';
+    headers: RequestHeaders;
+    retryNumber: number;
+    retryDelay: number;
 } | {
     type: 'download-progress';
     headers: RequestHeaders;

package/lib/request/request.util.d.ts

@@ -1,4 +1,4 @@
-import { Method, ParamArray, Params, QueryParams, RequestError, RequestHeaders, UnfilteredParamPrimitive } from './request.types';
+import { Method, ParamArray, Params, QueryParams, RequestError, RequestHeaders, RequestRetryFn, UnfilteredParamPrimitive } from './request.types';
 export declare const isRequestError: <T = unknown>(error: unknown) => error is RequestError<T>;
 export declare const buildRoute: (options: {
     base: string;
@@ -20,7 +20,9 @@ export declare const hasHeader: (headers: RequestHeaders, header: string) => boo
 export declare const forEachHeader: (headers: RequestHeaders, callback: (value: string, key: string) => void) => void;
 export declare const parseAllXhrResponseHeaders: (xhr: XMLHttpRequest) => RequestHeaders;
 export declare const getResponseUrl: (xhr: XMLHttpRequest) => string | null;
+export declare const shouldRetryRequest: RequestRetryFn;
 export declare const enum HttpStatusCode {
+    Unknown = 0,
     Continue = 100,
     SwitchingProtocols = 101,
     Processing = 102,

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ethlete/query",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "dependencies": {
     "tslib": "^2.3.0"
   },
   "peerDependencies": {
     "@angular/common": "^14.2.0 || ^15.0.0",
     "@angular/core": "^14.2.0 || ^15.0.0",
-    "@ethlete/core": "1.4.2"
+    "@ethlete/core": "1.4.3"
   },
   "module": "fesm2015/ethlete-query.mjs",
   "es2020": "fesm2020/ethlete-query.mjs",