@ethlete/query 4.4.1 → 4.5.0

package/lib/infinite-query/infinity-query.types.d.ts

@@ -1,4 +1,4 @@
-import { BaseArguments } from '../query';
+import { BaseArguments, WithHeaders } from '../query';
 import { AnyQueryCreator, ConstructQuery, QueryArgsOf, QueryResponseOf } from '../query-creator';
 import { InfinityQuery } from './infinity-query';
 export type InfinityQueryParamLocation = 'path' | 'query' | 'body' | 'header' | 'variable';
@@ -8,10 +8,10 @@ export interface PageParamCalculatorOptions {
     totalPages: number | null;
     itemsPerPage: number;
 }
-export interface TotalPagesExtractorOptions<QueryResponse, Arguments> {
+export interface TotalPagesExtractorOptions<Arguments extends BaseArguments | undefined, QueryResponse> {
     response: QueryResponse;
     itemsPerPage: number;
-    arguments: Arguments;
+    args: Arguments;
 }
 export interface InfinityQueryConfig<QueryCreator extends AnyQueryCreator, Arguments extends BaseArguments | undefined, QueryResponse, InfinityResponse extends unknown[]> {
     /**
@@ -21,7 +21,7 @@ export interface InfinityQueryConfig<QueryCreator extends AnyQueryCreator, Argum
     /**
      * The args that will be merged with the page arg.
      */
-    defaultArgs?: Arguments;
+    defaultArgs?: Arguments & WithHeaders;
     pageParam?: {
         /**
          * The location where the page param is in request.
@@ -88,7 +88,7 @@ export interface InfinityQueryConfig<QueryCreator extends AnyQueryCreator, Argum
          *
          * @default "totalPages"
          */
-        totalPagesExtractor?: (data: TotalPagesExtractorOptions<QueryResponse, Arguments>) => number;
+        totalPagesExtractor?: (data: TotalPagesExtractorOptions<QueryArgsOf<QueryCreator> & WithHeaders, QueryResponse>) => number;
     };
 }
 type OmitUndefined<T> = T extends undefined ? never : T;

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

@@ -107,4 +107,20 @@ export interface BuildQueryStringConfig {
      * @default false
      */
     writeArrayIndexes?: boolean;
+    /**
+     * A list of values that should be ignored when building the query string.
+     *
+     * Also have a look at `ignoredValuesFns`.
+     *
+     * @default [undefined, null, Infinity, -Infinity]
+     */
+    ignoredValues?: Array<unknown>;
+    /**
+     * A list of functions that should be used to determine whether a value should be ignored when building the query string.
+     *
+     * Also have a look at `ignoredValues`.
+     *
+     * @default [isNaN, isEmptyString]
+     */
+    ignoredValuesFns?: Array<(value: unknown) => boolean>;
 }

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

@@ -1,4 +1,6 @@
 import { BuildQueryStringConfig, Method, QueryParams, RequestError, RequestHeaders, RequestRetryFn } from './request.types';
+export declare const isNaN: (value: unknown) => boolean;
+export declare const isEmptyString: (value: unknown) => boolean;
 export declare const isRequestError: <T = unknown>(error: unknown) => error is RequestError<T>;
 export declare const buildRoute: (options: {
     base: string;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ethlete/query",
-  "version": "4.4.1",
+  "version": "4.5.0",
   "dependencies": {
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
     "@angular/common": "^15.2.1 || ^16.0.0",
     "@angular/core": "^15.2.1 || ^16.0.0",
-    "@ethlete/core": "2.8.0"
+    "@ethlete/core": "2.8.1"
   },
   "module": "fesm2022/ethlete-query.mjs",
   "typings": "index.d.ts",